eBay::API::XML::DataType::MeasureType - eBay::API::XML::DataType::MeasureType documentation

eBay-API documentation Contained in the eBay-API distribution.

Index

Code Index:

NAME

Top

eBay::API::XML::DataType::MeasureType

DESCRIPTION

Top

Basic type for specifying measures and the system of measurement. A decimal value (e.g., 10.25) is meaningful as a measure when accompanied by a definition of the unit of measure (e.g., Pounds), in which case the value specifies the quantity of that unit. A MeasureType expresses both the value (a decimal) and, optionally, the unit and the system of measurement. Details such as shipping weights are specified as measure types.

SYNOPSIS

Top

INHERITANCE

Top

eBay::API::XML::DataType::MeasureType inherits from the eBay::API::XML::BaseDataType class

Subroutines:

Top

setValue()

# Argument: 'xs:decimal'

getValue()

# Returns: 'xs:decimal'

setMeasurementSystem()

The system of measurement (e.g., English).

  Calls: AddItem
  RequiredInput: No

# Argument: 'ns:MeasurementSystemCodeType'

getMeasurementSystem()

  Calls: GetItem
  Returned: Conditionally
  Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll

  Calls: GetShippingDiscountProfiles
  Returned: Conditionally

# Returns: 'ns:MeasurementSystemCodeType'

setUnit()

The unit of measure (e.g., lbs, oz, in). Currently ignored and assumed to be "inches" when used as input for PackageDepth, PackageWidth, PackageLength, WeightMajor, WeightMinor.

  Calls: AddItem
  RequiredInput: No

# Argument: 'xs:token'

getUnit()

  Calls: GetItemShipping
         GetSellerTransactions
         GetShippingDiscountProfiles
  Returned: Conditionally

  Calls: GetItem
  Returned: Conditionally
  Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll

# Returns: 'xs:token'

eBay-API documentation Contained in the eBay-API distribution. 
#!/usr/bin/perl

package eBay::API::XML::DataType::MeasureType;

use strict;
use warnings;  

##########################################################################
#
# Module: ............... <user defined location>eBay/API/XML
# File: ................. MeasureType.pm
# Generated by: ......... genEBayApiDataTypes.pl
# Last Generated: ....... 08/24/2008 16:44
# API Release Number: ... 579
#
##########################################################################  


use eBay::API::XML::BaseDataType;
our @ISA = ("eBay::API::XML::BaseDataType");

use eBay::API::XML::DataType::Enum::MeasurementSystemCodeType;


my @gaProperties = ( [ 'content', 'xs:decimal', '', '', '' ]
                    );
push @gaProperties, @{eBay::API::XML::BaseDataType::getPropertiesList()};

my @gaAttributes = ( [ 'measurementSystem', 'ns:MeasurementSystemCodeType', ''
	     ,'eBay::API::XML::DataType::Enum::MeasurementSystemCodeType', '' ]
	, [ 'unit', 'xs:token', '', '', '' ]
                    );
push @gaAttributes, @{eBay::API::XML::BaseDataType::getAttributesList()};


sub new {
  my $classname = shift;
  my %args = @_;
  my $self = $classname->SUPER::new(%args);
  return $self;
}

sub isScalar {
   return 0; 
}




sub setValue {
  my $self = shift;
  $self->{'content'} = shift
}


sub getValue {
  my $self = shift;
  return $self->{'content'};
}





sub setMeasurementSystem {
  my $self = shift;
  $self->{'measurementSystem'} = shift
}


sub getMeasurementSystem {
  my $self = shift;
  return $self->{'measurementSystem'};
}



sub setUnit {
  my $self = shift;
  $self->{'unit'} = shift
}


sub getUnit {
  my $self = shift;
  return $self->{'unit'};
}



##  Attribute and Property lists
sub getPropertiesList {
   my $self = shift;
   return \@gaProperties;
}

sub getAttributesList {
   my $self = shift;
   return \@gaAttributes;
}



1;