eBay::API::XML::Call::GetLiveAuctionBidders::GetLiveAuctionBiddersRequestType - eBay::API::XML::Call::GetLiveAuctionBidders::GetLiveAuctionBiddersRequestType documentation

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

Index

Code Index:

NAME

Top

eBay::API::XML::Call::GetLiveAuctionBidders::GetLiveAuctionBiddersRequestType

DESCRIPTION

Top

Includes the list of bidders for the requested catalog.

SYNOPSIS

Top

INHERITANCE

Top

eBay::API::XML::Call::GetLiveAuctionBidders::GetLiveAuctionBiddersRequestType inherits from the eBay::API::XML::RequestDataType class

Subroutines:

Top

setBidderStatus()

The seller can ask to retrieve a subset of users in the bidder approval list who are either "approved","denied", or "pending" or a combination of these. If this field is not specified in the request, all records are returned.

  RequiredInput: No
#    Argument: reference to an array  
                      of 'ns:BidderStatusCodeType'

getBidderStatus()

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

setPagination()

Child elements control pagination of the output. Use its EntriesPerPage property to control the number of bidders to return per call and its PageNumber property to specify the page of data to return.

  RequiredInput: No
#    Argument: 'ns:PaginationType'

getPagination()

# Returns: 'ns:PaginationType'

setUserCatalogID()

Number that identifies the seller's eBay Live Auctions catalog for which they want to retrieve bidder requests.

  RequiredInput: Yes
#    Argument: 'xs:int'

getUserCatalogID()

# Returns: 'xs:int'

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

package eBay::API::XML::Call::GetLiveAuctionBidders::GetLiveAuctionBiddersRequestType;

use strict;
use warnings;  

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


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

use eBay::API::XML::DataType::PaginationType;
use eBay::API::XML::DataType::Enum::BidderStatusCodeType;


my @gaProperties = ( [ 'BidderStatus', 'ns:BidderStatusCodeType', '1'
	     ,'eBay::API::XML::DataType::Enum::BidderStatusCodeType', '' ]
	, [ 'Pagination', 'ns:PaginationType', ''
	     ,'eBay::API::XML::DataType::PaginationType', '1' ]
	, [ 'UserCatalogID', 'xs:int', '', '', '' ]
                    );
push @gaProperties, @{eBay::API::XML::RequestDataType::getPropertiesList()};

my @gaAttributes = ( 
                    );
push @gaAttributes, @{eBay::API::XML::RequestDataType::getAttributesList()};


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

sub isScalar {
   return 0; 
}




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


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



sub setPagination {
  my $self = shift;
  $self->{'Pagination'} = shift
}


sub getPagination {
  my $self = shift;
  return $self->_getDataTypeInstance( 'Pagination'
		,'eBay::API::XML::DataType::PaginationType');
}



sub setUserCatalogID {
  my $self = shift;
  $self->{'UserCatalogID'} = shift
}


sub getUserCatalogID {
  my $self = shift;
  return $self->{'UserCatalogID'};
}





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

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



1;