eBay::API::XML::DataType::WishListType - eBay::API::XML::DataType::WishListType documentation


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

Index


Code Index:

NAME

Top

eBay::API::XML::DataType::WishListType

DESCRIPTION

Top

This type contains the data for one eBay Express wish list.

SYNOPSIS

Top

INHERITANCE

Top

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

Subroutines:

Top

setDescription()

User-entered description of the wish list.

# Argument: 'xs:string'

getDescription()

  Calls: GetExpressWishList
  Returned: Conditionally

# Returns: 'xs:string'

setFirstName()

eBay user first name.

# Argument: 'xs:string'

getFirstName()

  Calls: GetExpressWishList
  Returned: Always

# Returns: 'xs:string'

setLastName()

eBay user last name.

# Argument: 'xs:string'

getLastName()

  Calls: GetExpressWishList
  Returned: Always

# Returns: 'xs:string'

setName()

The user-assigned name of the wish list.

# Argument: 'xs:string'

getName()

  Calls: GetExpressWishList
  Returned: Always

# Returns: 'xs:string'

setUserLocation()

Location of the creator of the wish list (Example: CA, United States).

# Argument: 'xs:string'

getUserLocation()

  Calls: GetExpressWishList
  Returned: Always

# Returns: 'xs:string'

setWishListEntry()

Product or item the user has added to the wish list. Returned only if request specifies WishListID.

# Argument: reference to an array of 'ns:WishListEntryType'

getWishListEntry()

  Calls: GetExpressWishList
  Returned: Conditionally

# Returns: reference to an array of 'ns:WishListEntryType'

setWishListID()

ID that uniquely identifies an eBay Express wish list.

# Argument: 'xs:string'

getWishListID()

  Calls: GetExpressWishList
  Returned: Always

# Returns: 'xs:string'

setWishListURL()

The URL of the wish list.

# Argument: 'xs:anyURI'

getWishListURL()

  Calls: GetExpressWishList
  Returned: Always

# Returns: 'xs:anyURI'


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

package eBay::API::XML::DataType::WishListType;

use strict;
use warnings;  

##########################################################################
#
# Module: ............... <user defined location>eBay/API/XML
# File: ................. WishListType.pm
# Generated by: ......... genEBayApiDataTypes.pl
# Last Generated: ....... 07/07/2008 17:42
# API Release Number: ... 571
#
##########################################################################  

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

use eBay::API::XML::DataType::WishListEntryType;


my @gaProperties = ( [ 'Description', 'xs:string', '', '', '' ]
	, [ 'FirstName', 'xs:string', '', '', '' ]
	, [ 'LastName', 'xs:string', '', '', '' ]
	, [ 'Name', 'xs:string', '', '', '' ]
	, [ 'UserLocation', 'xs:string', '', '', '' ]
	, [ 'WishListEntry', 'ns:WishListEntryType', '1'
	     ,'eBay::API::XML::DataType::WishListEntryType', '1' ]
	, [ 'WishListID', 'xs:string', '', '', '' ]
	, [ 'WishListURL', 'xs:anyURI', '', '', '' ]
                    );
push @gaProperties, @{eBay::API::XML::BaseDataType::getPropertiesList()};

my @gaAttributes = ( 
                    );
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 setDescription {
  my $self = shift;
  $self->{'Description'} = shift
}

sub getDescription {
  my $self = shift;
  return $self->{'Description'};
}


sub setFirstName {
  my $self = shift;
  $self->{'FirstName'} = shift
}

sub getFirstName {
  my $self = shift;
  return $self->{'FirstName'};
}


sub setLastName {
  my $self = shift;
  $self->{'LastName'} = shift
}

sub getLastName {
  my $self = shift;
  return $self->{'LastName'};
}


sub setName {
  my $self = shift;
  $self->{'Name'} = shift
}

sub getName {
  my $self = shift;
  return $self->{'Name'};
}


sub setUserLocation {
  my $self = shift;
  $self->{'UserLocation'} = shift
}

sub getUserLocation {
  my $self = shift;
  return $self->{'UserLocation'};
}


sub setWishListEntry {
  my $self = shift;
  $self->{'WishListEntry'} = 
		$self->convertArray_To_RefToArrayIfNeeded(@_);
}

sub getWishListEntry {
  my $self = shift;
  return $self->_getDataTypeArray('WishListEntry');
}


sub setWishListID {
  my $self = shift;
  $self->{'WishListID'} = shift
}

sub getWishListID {
  my $self = shift;
  return $self->{'WishListID'};
}


sub setWishListURL {
  my $self = shift;
  $self->{'WishListURL'} = shift
}

sub getWishListURL {
  my $self = shift;
  return $self->{'WishListURL'};
}





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

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



1;