Changes since
the last release

com.ebay.sdk.call
Class GetBidderListCall

java.lang.Object
  extended by com.ebay.sdk.ApiCall
      extended by com.ebay.sdk.call.GetBidderListCall

public class GetBidderListCall
extends ApiCall

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.


Input property: 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.
Input property: 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. This field is ignored if ActiveItemsOnly is set to true.
Input property: 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 set to true. Note that for GTC items, whose end times automatically increment by 30 days every 30 days, an EndTimeTo value within the first 30 days of a listing will refer to the listing's initial end time.
Input property: UserID - The user for whom information should be returned. If provided, overrides any user ID specified through the RequesterCredentials header.
Input property: 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.
Output property: ReturnedBidder - Data for one eBay bidder.
Output property: ReturnedBidItemArray - Array of items the bidder has bid on, has won or has lost.

Version:
1.0
Author:
Ron Murphy

Field Summary
 
Fields inherited from class com.ebay.sdk.ApiCall
apiException, sendReqListeners
 
Constructor Summary
GetBidderListCall()
          Constructor.
GetBidderListCall(ApiContext apiContext)
          Constructor.
 
Method Summary
 java.lang.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.
 java.util.Calendar getEndTimeFrom()
          Gets the GetBidderListRequestType.endTimeFrom.
 java.util.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.
 java.lang.String getUserID()
          Gets the GetBidderListRequestType.userID.
 void setActiveItemsOnly(java.lang.Boolean activeItemsOnly)
          Sets the GetBidderListRequestType.activeItemsOnly.
 void setEndTimeFrom(java.util.Calendar endTimeFrom)
          Sets the GetBidderListRequestType.endTimeFrom.
 void setEndTimeTo(java.util.Calendar endTimeTo)
          Sets the GetBidderListRequestType.endTimeTo.
 void setgranularityLevel(GranularityLevelCodeType granularityLevel)
          Sets the GetBidderListRequestType.granularityLevel.
 void setUserID(java.lang.String userID)
          Sets the GetBidderListRequestType.userID.
 
Methods inherited from class com.ebay.sdk.ApiCall
addDetailLevel, addSendRequestListener, execute, executeByApiName, getApiContext, getApiException, getBotBlock, getCallRetry, getDetailLevel, getEnableCompression, getEndUserIP, getErrorHandling, getInvocationID, getMessageID, getOutputSelector, getRequestXml, getResponseObject, getResponseXml, getSite, getWarningLevel, hasError, hasWarning, isEnableoAuthTokenHTTPHeader, removeSendRequestListener, setApiContext, setBotBlock, setCallRetry, setDetailLevel, setEnableCompression, setEnableoAuthTokenHTTPHeader, setEndUserIP, setErrorHandling, setInvocationID, setMessageID, setOutputSelector, setSite, setWarningLevel
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

GetBidderListCall

public GetBidderListCall()
Constructor.


GetBidderListCall

public GetBidderListCall(ApiContext apiContext)
Constructor.

Parameters:
apiContext - The ApiContext object to be used to make the call.
Method Detail

getBidderList

public void getBidderList()
                   throws ApiException,
                          SdkException,
                          java.lang.Exception
Retrieves all items the user is currently bidding on, and the ones they have won or purchased.

Throws:
ApiException
SdkException
java.lang.Exception

getActiveItemsOnly

public java.lang.Boolean getActiveItemsOnly()
Gets the GetBidderListRequestType.activeItemsOnly.

Returns:
Boolean

setActiveItemsOnly

public void setActiveItemsOnly(java.lang.Boolean activeItemsOnly)
Sets the GetBidderListRequestType.activeItemsOnly.

Parameters:
activeItemsOnly - Boolean

getEndTimeFrom

public java.util.Calendar getEndTimeFrom()
Gets the GetBidderListRequestType.endTimeFrom.

Returns:
Calendar

setEndTimeFrom

public void setEndTimeFrom(java.util.Calendar endTimeFrom)
Sets the GetBidderListRequestType.endTimeFrom.

Parameters:
endTimeFrom - Calendar

getEndTimeTo

public java.util.Calendar getEndTimeTo()
Gets the GetBidderListRequestType.endTimeTo.

Returns:
Calendar

setEndTimeTo

public void setEndTimeTo(java.util.Calendar endTimeTo)
Sets the GetBidderListRequestType.endTimeTo.

Parameters:
endTimeTo - Calendar

getUserID

public java.lang.String getUserID()
Gets the GetBidderListRequestType.userID.

Returns:
String

setUserID

public void setUserID(java.lang.String userID)
Sets the GetBidderListRequestType.userID.

Parameters:
userID - String

getReturnedBidItemArray

public ItemType[] getReturnedBidItemArray()
Valid after executing the API. Gets the returned GetBidderListResponseType.returnedBidItemArray.

Returns:
ItemType[]

getReturnedBidder

public UserType getReturnedBidder()
Valid after executing the API. Gets the returned GetBidderListResponseType.returnedBidder.

Returns:
UserType

getgranularityLevel

public GranularityLevelCodeType getgranularityLevel()
Gets the GetBidderListRequestType.granularityLevel.

Returns:
GranularityLevelCodeType

setgranularityLevel

public void setgranularityLevel(GranularityLevelCodeType granularityLevel)
Sets the GetBidderListRequestType.granularityLevel.

Parameters:
granularityLevel - GranularityLevelCodeType

Changes since
the last release

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.