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


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

Index


Code Index:

NAME

Top

eBay::API::XML::Call::GetLiveAuctionBidders::GetLiveAuctionBiddersResponseType

DESCRIPTION

Top

Includes the list of bidders for the requested catalog.

SYNOPSIS

Top

INHERITANCE

Top

eBay::API::XML::Call::GetLiveAuctionBidders::GetLiveAuctionBiddersResponseType inherits from the eBay::API::XML::ResponseDataType class

Subroutines:

Top

setBidderDetails()

Contains the bidder details that match the bidder query passed in the request. Returned when bidder search results are found.

# Argument: 'ns:BidderDetailArrayType'

getBidderDetails()

  Returned: Conditionally
#    Returns: 'ns:BidderDetailArrayType'

setPageNumber()

The page number for the page of data returned.

# Argument: 'xs:int'

getPageNumber()

  Returned: Conditionally
#    Returns: 'xs:int'

setPaginationResult()

Shows the pagination of data returned by requests. Only returned if Pagination was specified in the request.

# Argument: 'ns:PaginationResultType'

getPaginationResult()

  Returned: Conditionally
#    Returns: 'ns:PaginationResultType'

setTotalApproved()

Total number of bidders in Approved state.

# Argument: 'xs:int'

getTotalApproved()

  Returned: Always
#    Returns: 'xs:int'

setTotalDenied()

Total number of bidders in Denied state.

# Argument: 'xs:int'

getTotalDenied()

  Returned: Always
#    Returns: 'xs:int'

setTotalPending()

Total number of bidders in Pending state.

# Argument: 'xs:int'

getTotalPending()

  Returned: Always
#    Returns: 'xs:int'


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

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

use strict;
use warnings;  

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

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

use eBay::API::XML::DataType::BidderDetailArrayType;
use eBay::API::XML::DataType::PaginationResultType;


my @gaProperties = ( [ 'BidderDetails', 'ns:BidderDetailArrayType', ''
	     ,'eBay::API::XML::DataType::BidderDetailArrayType', '1' ]
	, [ 'PageNumber', 'xs:int', '', '', '' ]
	, [ 'PaginationResult', 'ns:PaginationResultType', ''
	     ,'eBay::API::XML::DataType::PaginationResultType', '1' ]
	, [ 'TotalApproved', 'xs:int', '', '', '' ]
	, [ 'TotalDenied', 'xs:int', '', '', '' ]
	, [ 'TotalPending', 'xs:int', '', '', '' ]
                    );
push @gaProperties, @{eBay::API::XML::ResponseDataType::getPropertiesList()};

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

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

sub isScalar {
   return 0; 
}



sub setBidderDetails {
  my $self = shift;
  $self->{'BidderDetails'} = shift
}

sub getBidderDetails {
  my $self = shift;
  return $self->_getDataTypeInstance( 'BidderDetails'
		,'eBay::API::XML::DataType::BidderDetailArrayType');
}


sub setPageNumber {
  my $self = shift;
  $self->{'PageNumber'} = shift
}

sub getPageNumber {
  my $self = shift;
  return $self->{'PageNumber'};
}


sub setPaginationResult {
  my $self = shift;
  $self->{'PaginationResult'} = shift
}

sub getPaginationResult {
  my $self = shift;
  return $self->_getDataTypeInstance( 'PaginationResult'
		,'eBay::API::XML::DataType::PaginationResultType');
}


sub setTotalApproved {
  my $self = shift;
  $self->{'TotalApproved'} = shift
}

sub getTotalApproved {
  my $self = shift;
  return $self->{'TotalApproved'};
}


sub setTotalDenied {
  my $self = shift;
  $self->{'TotalDenied'} = shift
}

sub getTotalDenied {
  my $self = shift;
  return $self->{'TotalDenied'};
}


sub setTotalPending {
  my $self = shift;
  $self->{'TotalPending'} = shift
}

sub getTotalPending {
  my $self = shift;
  return $self->{'TotalPending'};
}





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

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



1;