|
Changes since the last release |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ebay.sdk.ApiCall
com.ebay.sdk.call.GetAllBiddersCall
public class GetAllBiddersCall
Wrapper class of the GetAllBidders call of eBay SOAP API.
Title: SOAP API wrapper library.
Description: Contains wrapper classes for eBay SOAP APIs.
Copyright: Copyright (c) 2009
Company: eBay Inc.
ItemID
- This is the unique identifier of the auction listing for which bidders are being retrieved. This auction listing can be active or recently ended. However, to retrieve bidders for an active auction listing, the only CallMode enumeration value that can be used is ViewAll
.
CallMode
- The enumeration value that is passed into this field will control the set of bidders that will be retrieved in the response. To retrieve bidders from a recently-ended auction listing, any of the three values can be used. To retrieve bidders for an active auction listing, only the ViewAll
enumeration value can be used. These values are discussed in more detail below.
IncludeBiddingSummary
- The user must include this field and set its value to true
if the user wishes to retrieve the BiddingSummary container for each bidder. The BiddingSummary container consists of more detailed bidding information on each bidder.
ReturnedBidArray
- Contains a list of OfferType objects. Each
OfferType object represents the data for one bidder and bid.
ReturnedHighBidder
- eBay user ID for the user with the highest bid (or the earliest timestamp, in the event of a tie); a Second Chance Offer candidate.
ReturnedHighestBid
- Bid amount offered by the HighBidder.
ReturnedListingStatus
- Specifies an active or ended listing's status in eBay's processing workflow.
If a listing ends with a sale (or sales), eBay needs to update the sale details (e.g., winning bidder) and other information. This processing
can take several minutes. If you retrieve a sold item, use this listing status information to determine whether eBay has finished processing the listing so that you can be sure the winning bidder and other details are correct and complete.
Field Summary |
---|
Fields inherited from class com.ebay.sdk.ApiCall |
---|
apiException, sendReqListeners |
Constructor Summary | |
---|---|
GetAllBiddersCall()
Constructor. |
|
GetAllBiddersCall(ApiContext apiContext)
Constructor. |
Method Summary | |
---|---|
OfferType[] |
getAllBidders()
This is the base request type for the GetAllBidders call, which is used to retrieve bidders from an active or recently-ended auction listing. |
GetAllBiddersModeCodeType |
getCallMode()
Gets the GetAllBiddersRequestType.callMode. |
Boolean |
getIncludeBiddingSummary()
Gets the GetAllBiddersRequestType.includeBiddingSummary. |
String |
getItemID()
Gets the GetAllBiddersRequestType.itemID. |
OfferType[] |
getReturnedBidArray()
Valid after executing the API. |
String |
getReturnedHighBidder()
Valid after executing the API. |
AmountType |
getReturnedHighestBid()
Valid after executing the API. |
ListingStatusCodeType |
getReturnedListingStatus()
Valid after executing the API. |
void |
setCallMode(GetAllBiddersModeCodeType callMode)
Sets the GetAllBiddersRequestType.callMode. |
void |
setIncludeBiddingSummary(Boolean includeBiddingSummary)
Sets the GetAllBiddersRequestType.includeBiddingSummary. |
void |
setItemID(String itemID)
Sets the GetAllBiddersRequestType.itemID. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public GetAllBiddersCall()
public GetAllBiddersCall(ApiContext apiContext)
apiContext
- The ApiContext object to be used to make the call.Method Detail |
---|
public OfferType[] getAllBidders() throws ApiException, SdkException, Exception
ApiException
SdkException
Exception
public GetAllBiddersModeCodeType getCallMode()
public void setCallMode(GetAllBiddersModeCodeType callMode)
callMode
- GetAllBiddersModeCodeTypepublic Boolean getIncludeBiddingSummary()
public void setIncludeBiddingSummary(Boolean includeBiddingSummary)
includeBiddingSummary
- Booleanpublic String getItemID()
public void setItemID(String itemID)
itemID
- Stringpublic OfferType[] getReturnedBidArray()
public String getReturnedHighBidder()
public AmountType getReturnedHighestBid()
public ListingStatusCodeType getReturnedListingStatus()
|
Changes since the last release |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
The information contained in this document is proprietary and confidential.
Use of this information and the eBay API requires a Non-Disclosure Agreement (NDA) between the user and eBay Inc.
For information regarding a qualifying NDA, contact Developer Relations:
developer-relations@ebay.com
© 2004-2009 eBay Inc. All rights reserved.