com.ebay.sdk.call
Class ApproveLiveAuctionBiddersCall

java.lang.Object
  com.ebay.sdk.ApiCall
      com.ebay.sdk.call.ApproveLiveAuctionBiddersCall

public class ApproveLiveAuctionBiddersCall
extends ApiCall

Wrapper class of the ApproveLiveAuctionBidders call of eBay SOAP API.

Title: SOAP API wrapper library.

Description: Contains wrapper classes for eBay SOAP APIs.

Copyright: Copyright (c) 2007

Company: eBay Inc.

Input property: UserCatalogID - Number that identifies the seller's eBay Live Auctions catalog for which they want to set bidding limits and approve or decline bidders.
Input property: BidApproval - Approval details for a specific set of bidders.
Input property: ApproveAllPending - 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.
Input property: AllApprovedBiddingLimit - 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.
Output property: ReturnedBidderUpdateStatus - Contains the results of the request for each item. Mulitple bidders can be approved with one call.

Field Summary

Fields inherited from class com.ebay.sdk.ApiCall

apiException, fullCredentials, sendReqListeners

Constructor Summary

ApproveLiveAuctionBiddersCall()
Constructor.

ApproveLiveAuctionBiddersCall(ApiContext apiContext)
Constructor.

Method Summary

LiveAuctionApprovalStatusArrayType	approveLiveAuctionBidders() 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.
AmountType	getAllApprovedBiddingLimit() Gets the ApproveLiveAuctionBiddersRequestType.allApprovedBiddingLimit.
Boolean	getApproveAllPending() Gets the ApproveLiveAuctionBiddersRequestType.approveAllPending.
BidApprovalArrayType	getBidApproval() Gets the ApproveLiveAuctionBiddersRequestType.bidApproval.
LiveAuctionApprovalStatusArrayType	getReturnedBidderUpdateStatus() Valid after executing the API.
Integer	getUserCatalogID() Gets the ApproveLiveAuctionBiddersRequestType.userCatalogID.
void	setAllApprovedBiddingLimit(AmountType allApprovedBiddingLimit) Sets the ApproveLiveAuctionBiddersRequestType.allApprovedBiddingLimit.
void	setApproveAllPending(Boolean approveAllPending) Sets the ApproveLiveAuctionBiddersRequestType.approveAllPending.
void	setBidApproval(BidApprovalArrayType bidApproval) Sets the ApproveLiveAuctionBiddersRequestType.bidApproval.
void	setUserCatalogID(Integer userCatalogID) Sets the ApproveLiveAuctionBiddersRequestType.userCatalogID.

Methods inherited from class com.ebay.sdk.ApiCall

addDetailLevel, addSendRequestListener, execute, executeByApiName, getApiContext, getApiException, getCallRetry, getDetailLevel, getEnableCompression, getRequestXml, getResponseObject, getResponseXml, getSite, hasError, hasWarning, removeSendRequestListener, setApiContext, setCallRetry, setDetailLevel, setEnableCompression, setSite

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ApproveLiveAuctionBiddersCall

public ApproveLiveAuctionBiddersCall()

Constructor.

ApproveLiveAuctionBiddersCall

public ApproveLiveAuctionBiddersCall(ApiContext apiContext)

Constructor.

Parameters:

apiContext - The ApiContext object to be used to make the call.

Method Detail

approveLiveAuctionBidders

public LiveAuctionApprovalStatusArrayType approveLiveAuctionBidders()
                                                             throws ApiException,
                                                                    SdkException,
                                                                    Exception

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.

Returns:

The LiveAuctionApprovalStatusArrayType object.

Throws:

ApiException

SdkException

Exception

getAllApprovedBiddingLimit

public AmountType getAllApprovedBiddingLimit()

Gets the ApproveLiveAuctionBiddersRequestType.allApprovedBiddingLimit.

Returns:

AmountType

setAllApprovedBiddingLimit

public void setAllApprovedBiddingLimit(AmountType allApprovedBiddingLimit)

Sets the ApproveLiveAuctionBiddersRequestType.allApprovedBiddingLimit.

Parameters:

allApprovedBiddingLimit - AmountType

getApproveAllPending

public Boolean getApproveAllPending()

Gets the ApproveLiveAuctionBiddersRequestType.approveAllPending.

Returns:

Boolean

setApproveAllPending

public void setApproveAllPending(Boolean approveAllPending)

Sets the ApproveLiveAuctionBiddersRequestType.approveAllPending.

Parameters:

approveAllPending - Boolean

getBidApproval

public BidApprovalArrayType getBidApproval()

Gets the ApproveLiveAuctionBiddersRequestType.bidApproval.

Returns:

BidApprovalArrayType

setBidApproval

public void setBidApproval(BidApprovalArrayType bidApproval)

Sets the ApproveLiveAuctionBiddersRequestType.bidApproval.

Parameters:

bidApproval - BidApprovalArrayType

getUserCatalogID

public Integer getUserCatalogID()

Gets the ApproveLiveAuctionBiddersRequestType.userCatalogID.

Returns:

Integer

setUserCatalogID

public void setUserCatalogID(Integer userCatalogID)

Sets the ApproveLiveAuctionBiddersRequestType.userCatalogID.

Parameters:

userCatalogID - Integer

getReturnedBidderUpdateStatus

public LiveAuctionApprovalStatusArrayType getReturnedBidderUpdateStatus()

Valid after executing the API. Gets the returned ApproveLiveAuctionBiddersResponseType.returnedBidderUpdateStatus.

Returns:

LiveAuctionApprovalStatusArrayType