eBay::API::XML::Call::ApproveLiveAuctionBidders::ApproveLiveAuctionBiddersRequestType - eBay::API::XML::Call::ApproveLiveAuctionBidders::ApproveLiveAuctionBiddersRequestType documentation

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

Index

Code Index:

NAME

Top

eBay::API::XML::Call::ApproveLiveAuctionBidders::ApproveLiveAuctionBiddersRequestType

DESCRIPTION

Top

Provides Live Auction sellers with the ability to approve, decline, and set the bidding limit of the bidders that have signed up for a catalog. Includes the list of bidders for the requested item as part of the general item listing data.

SYNOPSIS

Top

INHERITANCE

Top

eBay::API::XML::Call::ApproveLiveAuctionBidders::ApproveLiveAuctionBiddersRequestType inherits from the eBay::API::XML::RequestDataType class

Subroutines:

Top

setAllApprovedBiddingLimit()

This is the amount that bidders are beings approved for. This is required if user has set ApproveAllPending to true. It only applies to bidder requests that are in pending status.

  RequiredInput: Conditionally
#    Argument: 'ns:AmountType'

getAllApprovedBiddingLimit()

# Returns: 'ns:AmountType'

setApproveAllPending()

This will approve all bidders in the catalog in the pending status only. This is an optional field. If provided and set to true, do not send BidApproval.

  RequiredInput: No
#    Argument: 'xs:boolean'

isApproveAllPending()

# Returns: 'xs:boolean'

setBidApproval()

Approval details for a specific set of bidders.

  RequiredInput: No
#    Argument: 'ns:BidApprovalArrayType'

getBidApproval()

# Returns: 'ns:BidApprovalArrayType'

setUserCatalogID()

Number that identifies the seller's eBay Live Auctions catalog for which they want to set bidding limits and approve or decline bidders.

  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::ApproveLiveAuctionBidders::ApproveLiveAuctionBiddersRequestType;

use strict;
use warnings;  

##########################################################################
#
# Module: ............... <user defined location>eBay/API/XML
# File: ................. ApproveLiveAuctionBiddersRequestType.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::AmountType;
use eBay::API::XML::DataType::BidApprovalArrayType;


my @gaProperties = ( [ 'AllApprovedBiddingLimit', 'ns:AmountType', ''
	     ,'eBay::API::XML::DataType::AmountType', '1' ]
	, [ 'ApproveAllPending', 'xs:boolean', '', '', '' ]
	, [ 'BidApproval', 'ns:BidApprovalArrayType', ''
	     ,'eBay::API::XML::DataType::BidApprovalArrayType', '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 setAllApprovedBiddingLimit {
  my $self = shift;
  $self->{'AllApprovedBiddingLimit'} = shift
}


sub getAllApprovedBiddingLimit {
  my $self = shift;
  return $self->_getDataTypeInstance( 'AllApprovedBiddingLimit'
		,'eBay::API::XML::DataType::AmountType');
}



sub setApproveAllPending {
  my $self = shift;
  $self->{'ApproveAllPending'} = shift
}


sub isApproveAllPending {
  my $self = shift;
  return $self->{'ApproveAllPending'};
}



sub setBidApproval {
  my $self = shift;
  $self->{'BidApproval'} = shift
}


sub getBidApproval {
  my $self = shift;
  return $self->_getDataTypeInstance( 'BidApproval'
		,'eBay::API::XML::DataType::BidApprovalArrayType');
}



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;