Changes since
the last release

com.ebay.sdk.call
Class GetUserCall

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

public class GetUserCall
extends ApiCall

Wrapper class of the GetUser 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: ItemID - Specify the item ID for a successfully concluded listing in which the requestor and target user were participants (one as seller and the other as buyer). Necessary to return certain data (like an email address). Not necessary if the requestor is retrieving their own data. ItemID is an optional input.
Input property: UserID - Specify the user whose data you want returned by the call. UserID is optional. If not specified, eBay returns data pertaining to the requesting user (as specified with the eBayAuthToken).
Input property: IncludeExpressRequirements - This field is deprecated.
Input property: IncludeFeatureEligibility - If the IncludeFeatureEligibility flag is included and set to 'true', the call response will include a QualifiesForSelling flag which indicates if the eBay user is eligible to sell on eBay, and a IncludeFeatureEligibility container which indicates which selling features are available to the user.
Output property: ReturnedUser - Contains the returned user data for the specified eBay user.

Version:
1.0
Author:
Ron Murphy

Field Summary
 
Fields inherited from class com.ebay.sdk.ApiCall
apiException, sendReqListeners
 
Constructor Summary
GetUserCall()
          Constructor.
GetUserCall(ApiContext apiContext)
          Constructor.
 
Method Summary
 Boolean getIncludeExpressRequirements()
          Gets the GetUserRequestType.includeExpressRequirements.
 Boolean getIncludeFeatureEligibility()
          Gets the GetUserRequestType.includeFeatureEligibility.
 String getItemID()
          Gets the GetUserRequestType.itemID.
 UserType getReturnedUser()
          Valid after executing the API.
 UserType getUser()
          Retrieves data pertaining to a single eBay user.
 String getUserID()
          Gets the GetUserRequestType.userID.
 void setIncludeExpressRequirements(Boolean includeExpressRequirements)
          Sets the GetUserRequestType.includeExpressRequirements.
 void setIncludeFeatureEligibility(Boolean includeFeatureEligibility)
          Sets the GetUserRequestType.includeFeatureEligibility.
 void setItemID(String itemID)
          Sets the GetUserRequestType.itemID.
 void setUserID(String userID)
          Sets the GetUserRequestType.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, removeSendRequestListener, setApiContext, setBotBlock, setCallRetry, setDetailLevel, setEnableCompression, 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

GetUserCall

public GetUserCall()
Constructor.


GetUserCall

public GetUserCall(ApiContext apiContext)
Constructor.

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

getUser

public UserType getUser()
                 throws ApiException,
                        SdkException,
                        Exception
Retrieves data pertaining to a single eBay user. Callers can use this call to return their own user data or the data of another eBay user. Unless the caller passes in an ItemID that identifies a current or past common order, not all data (like email addresses) will be returned in the User object.

Returns:
The UserType object.
Throws:
ApiException
SdkException
Exception

getIncludeExpressRequirements

public Boolean getIncludeExpressRequirements()
Gets the GetUserRequestType.includeExpressRequirements.

Returns:
Boolean

setIncludeExpressRequirements

public void setIncludeExpressRequirements(Boolean includeExpressRequirements)
Sets the GetUserRequestType.includeExpressRequirements.

Parameters:
includeExpressRequirements - Boolean

getIncludeFeatureEligibility

public Boolean getIncludeFeatureEligibility()
Gets the GetUserRequestType.includeFeatureEligibility.

Returns:
Boolean

setIncludeFeatureEligibility

public void setIncludeFeatureEligibility(Boolean includeFeatureEligibility)
Sets the GetUserRequestType.includeFeatureEligibility.

Parameters:
includeFeatureEligibility - Boolean

getItemID

public String getItemID()
Gets the GetUserRequestType.itemID.

Returns:
String

setItemID

public void setItemID(String itemID)
Sets the GetUserRequestType.itemID.

Parameters:
itemID - String

getUserID

public String getUserID()
Gets the GetUserRequestType.userID.

Returns:
String

setUserID

public void setUserID(String userID)
Sets the GetUserRequestType.userID.

Parameters:
userID - String

getReturnedUser

public UserType getReturnedUser()
Valid after executing the API. Gets the returned GetUserResponseType.returnedUser.

Returns:
UserType

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.