|
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.GetBidderListCall
public class GetBidderListCall
Wrapper class of the GetBidderList 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.
ActiveItemsOnly
- Indicates whether or not to limit the result set to active items. If true, only
active items are returned and the EndTimeFrom and EndTimeTo filters are
ignored. If false (or not sent), both active and ended items are returned.
EndTimeFrom
- Used in conjunction with EndTimeTo. Limits returned items to only those for
which the item's end date is on or after the date-time specified. Specify an
end date within 30 days prior to today. Items that ended more than 30 days
ago are omitted from the results. If specified, EndTimeTo must also be
specified. Express date-time in the format YYYY-MM-DD HH:MM:SS, and in GMT.
(For information on how to convert between your local time zone and GMT, see
Time Values Note.) This field is ignored if ActiveItemsOnly is true.
EndTimeTo
- Used in conjunction with EndTimeFrom. Limits returned items to only those for
which the item's end date is on or before the date-time specified. If
specified, EndTimeFrom must also be specified. Express date-time in the format
YYYY-MM-DD HH:MM:SS, and in GMT. This field is ignored if ActiveItemsOnly is
true. Note that for GTC items, whose end times automatically increment by 30
days every 30 days, an EndTimeTo within in the first 30 days of a listing will
refer to the listing's initial end time.
UserID
- The user for whom information should be returned. If
provided, overrides user defined via RequesterCredentials
in header.
granularityLevel
- You can control some of the fields returned in the response by specifying one
of two values in the GranularityLevel field: Fine or Medium. Fine returns
more fields than the default, while setting this field to Medium returns an
abbreviated set of results.
ReturnedBidder
- Data for one eBay bidder.
ReturnedBidItemArray
- Array of items the bidder has bid on, has won or has lost.
Field Summary |
---|
Fields inherited from class com.ebay.sdk.ApiCall |
---|
apiException, sendReqListeners |
Constructor Summary | |
---|---|
GetBidderListCall()
Constructor. |
|
GetBidderListCall(ApiContext apiContext)
Constructor. |
Method Summary | |
---|---|
Boolean |
getActiveItemsOnly()
Gets the GetBidderListRequestType.activeItemsOnly. |
void |
getBidderList()
Retrieves all items the user is currently bidding on, and the ones they have won or purchased. |
Calendar |
getEndTimeFrom()
Gets the GetBidderListRequestType.endTimeFrom. |
Calendar |
getEndTimeTo()
Gets the GetBidderListRequestType.endTimeTo. |
GranularityLevelCodeType |
getgranularityLevel()
Gets the GetBidderListRequestType.granularityLevel. |
UserType |
getReturnedBidder()
Valid after executing the API. |
ItemType[] |
getReturnedBidItemArray()
Valid after executing the API. |
String |
getUserID()
Gets the GetBidderListRequestType.userID. |
void |
setActiveItemsOnly(Boolean activeItemsOnly)
Sets the GetBidderListRequestType.activeItemsOnly. |
void |
setEndTimeFrom(Calendar endTimeFrom)
Sets the GetBidderListRequestType.endTimeFrom. |
void |
setEndTimeTo(Calendar endTimeTo)
Sets the GetBidderListRequestType.endTimeTo. |
void |
setgranularityLevel(GranularityLevelCodeType granularityLevel)
Sets the GetBidderListRequestType.granularityLevel. |
void |
setUserID(String userID)
Sets the GetBidderListRequestType.userID. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public GetBidderListCall()
public GetBidderListCall(ApiContext apiContext)
apiContext
- The ApiContext object to be used to make the call.Method Detail |
---|
public void getBidderList() throws ApiException, SdkException, Exception
ApiException
SdkException
Exception
public Boolean getActiveItemsOnly()
public void setActiveItemsOnly(Boolean activeItemsOnly)
activeItemsOnly
- Booleanpublic Calendar getEndTimeFrom()
public void setEndTimeFrom(Calendar endTimeFrom)
endTimeFrom
- Calendarpublic Calendar getEndTimeTo()
public void setEndTimeTo(Calendar endTimeTo)
endTimeTo
- Calendarpublic String getUserID()
public void setUserID(String userID)
userID
- Stringpublic ItemType[] getReturnedBidItemArray()
public UserType getReturnedBidder()
public GranularityLevelCodeType getgranularityLevel()
public void setgranularityLevel(GranularityLevelCodeType granularityLevel)
granularityLevel
- GranularityLevelCodeType
|
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.