eBay::API::XML::Call::GetExpressWishList - eBay::API::XML::Call::GetExpressWishList documentation

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

Index

Code Index:

NAME

Top

eBay::API::XML::Call::GetExpressWishList

DESCRIPTION

Top

SYNOPSIS

Top

INHERITANCE

Top

eBay::API::XML::Call::GetExpressWishList inherits from the eBay::API::XML::BaseCall class

Subroutines:

Top

setFirstName()

User first name. Can be used in combination with LastName. Will be ignored if either UserID or WishListID is included in the request.

  RequiredInput: No
#    Argument: 'xs:string'

setLastName()

User last name. Can be used in combination with FirstName. Will be ignored if either UserID or WishListID is included in the request.

  RequiredInput: No
#    Argument: 'xs:string'

setPagination()

Contains the data that control the pagination of items or products in any returned wish list.

  RequiredInput: No
#    Argument: 'ns:PaginationType'

setSortOrder()

Sort order for returned results. Default is CreationDateDescending, which returns the most recently added wish list items first.

  RequiredInput: No
#    Argument: 'ns:WishListSortCodeType'

setUserID()

eBay user ID. Can be used as an alternative to WishListID or to the combination FirstName and LastName. If WishListID is used, UserID will be ignored. This value is not returned in the response.

  RequiredInput: No
#    Argument: 'xs:string'

setWishListID()

Identifies an eBay Express wish list. When used in a request, UserID and FirstName and LastName are ignored.

  RequiredInput: No
#    Argument: 'xs:string'

getPagination()

Child elements control the display pagination of the items and products in retrieved wish lists.

  Returned: Always
#    Returns: 'ns:PaginationResultType'

getWishList()

Contains the contents and description of the requested wish list.

  Returned: Always
#    Returns: reference to an array  
                      of 'ns:WishListType'
eBay-API documentation Contained in the eBay-API distribution. 
#!/usr/bin/perl

package eBay::API::XML::Call::GetExpressWishList;

use strict;
use warnings;  

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


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

use eBay::API::XML::Call::GetExpressWishList::GetExpressWishListRequestType;
use eBay::API::XML::Call::GetExpressWishList::GetExpressWishListResponseType;



sub getApiCallName {
   return 'GetExpressWishList';
}
sub getRequestDataTypeFullPackage {
   return 'eBay::API::XML::Call::GetExpressWishList::GetExpressWishListRequestType';
}
sub getResponseDataTypeFullPackage {
   return 'eBay::API::XML::Call::GetExpressWishList::GetExpressWishListResponseType';
}

#
# input properties
#


       
sub setFirstName {
   my $self   = shift;
   my $sFirstName = shift;
   $self->getRequestDataType()->setFirstName($sFirstName);
}


       
sub setLastName {
   my $self   = shift;
   my $sLastName = shift;
   $self->getRequestDataType()->setLastName($sLastName);
}


       
sub setPagination {
   my $self   = shift;
   my $pPagination = shift;
   $self->getRequestDataType()->setPagination($pPagination);
}


       
sub setSortOrder {
   my $self   = shift;
   my $sSortOrder = shift;
   $self->getRequestDataType()->setSortOrder($sSortOrder);
}


       
sub setUserID {
   my $self   = shift;
   my $sUserID = shift;
   $self->getRequestDataType()->setUserID($sUserID);
}


       
sub setWishListID {
   my $self   = shift;
   my $sWishListID = shift;
   $self->getRequestDataType()->setWishListID($sWishListID);
}



#
# output properties
#


       
sub getPagination {
   my $self = shift;
   return $self->getResponseDataType()->getPagination();
}


       
sub getWishList {
   my $self = shift;
   return $self->getResponseDataType()->getWishList();
}





1;