Changes since
the last release

com.ebay.sdk.call
Class GetUserContactDetailsCall

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

public class GetUserContactDetailsCall
extends ApiCall

Wrapper class of the GetUserContactDetails 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 - A unique identifier for the eBay listing that the caller and order partner have in common.
Input property: ContactID - An eBay user ID that uniquely identifies a given user for whom the caller is seeking information. Either a seller's or bidder's/buyer's user ID can be specified here, as long as an bidding/order relationship exists between the requester and the user specified by this field. That is, a bidder must be bidding on the seller's active auction item, or a prospective buyer has proposed a Best Offer on a listing.
Input property: RequesterID - An eBay user ID that uniquely identifies the person who is making the call. Either a seller's or bidder's/buyer's user ID can be specified here, as long as a bidding/order relationship exists between the requester and the user for whom information is being requested.
Output property: ReturnedUserID - An eBay ID that uniquely identifies the given user whose information is given in the call response.
Output property: ReturnedContactAddress - Contact information for the requested contact. Note that the email address is NOT returned.
Output property: ReturnedRegistrationDate - The date and time that the requested contact registered with eBay.

Version:
1.0
Author:
Ron Murphy

Field Summary
 
Fields inherited from class com.ebay.sdk.ApiCall
apiException, sendReqListeners
 
Constructor Summary
GetUserContactDetailsCall()
          Constructor.
GetUserContactDetailsCall(ApiContext apiContext)
          Constructor.
 
Method Summary
 java.lang.String getContactID()
          Gets the GetUserContactDetailsRequestType.contactID.
 java.lang.String getItemID()
          Gets the GetUserContactDetailsRequestType.itemID.
 java.lang.String getRequesterID()
          Gets the GetUserContactDetailsRequestType.requesterID.
 AddressType getReturnedContactAddress()
          Valid after executing the API.
 java.util.Calendar getReturnedRegistrationDate()
          Valid after executing the API.
 java.lang.String getReturnedUserID()
          Valid after executing the API.
 java.lang.String getUserContactDetails()
          This call is used to retrieve contact information for a specified eBay user, given that a bidding relationship (as either a buyer or seller) exists between the caller and the user.
 void setContactID(java.lang.String contactID)
          Sets the GetUserContactDetailsRequestType.contactID.
 void setItemID(java.lang.String itemID)
          Sets the GetUserContactDetailsRequestType.itemID.
 void setRequesterID(java.lang.String requesterID)
          Sets the GetUserContactDetailsRequestType.requesterID.
 
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

GetUserContactDetailsCall

public GetUserContactDetailsCall()
Constructor.


GetUserContactDetailsCall

public GetUserContactDetailsCall(ApiContext apiContext)
Constructor.

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

getUserContactDetails

public java.lang.String getUserContactDetails()
                                       throws ApiException,
                                              SdkException,
                                              java.lang.Exception
This call is used to retrieve contact information for a specified eBay user, given that a bidding relationship (as either a buyer or seller) exists between the caller and the user.

Returns:
The String object.
Throws:
ApiException
SdkException
java.lang.Exception

getContactID

public java.lang.String getContactID()
Gets the GetUserContactDetailsRequestType.contactID.

Returns:
String

setContactID

public void setContactID(java.lang.String contactID)
Sets the GetUserContactDetailsRequestType.contactID.

Parameters:
contactID - String

getItemID

public java.lang.String getItemID()
Gets the GetUserContactDetailsRequestType.itemID.

Returns:
String

setItemID

public void setItemID(java.lang.String itemID)
Sets the GetUserContactDetailsRequestType.itemID.

Parameters:
itemID - String

getRequesterID

public java.lang.String getRequesterID()
Gets the GetUserContactDetailsRequestType.requesterID.

Returns:
String

setRequesterID

public void setRequesterID(java.lang.String requesterID)
Sets the GetUserContactDetailsRequestType.requesterID.

Parameters:
requesterID - String

getReturnedContactAddress

public AddressType getReturnedContactAddress()
Valid after executing the API. Gets the returned GetUserContactDetailsResponseType.returnedContactAddress.

Returns:
AddressType

getReturnedRegistrationDate

public java.util.Calendar getReturnedRegistrationDate()
Valid after executing the API. Gets the returned GetUserContactDetailsResponseType.returnedRegistrationDate.

Returns:
Calendar

getReturnedUserID

public java.lang.String getReturnedUserID()
Valid after executing the API. Gets the returned GetUserContactDetailsResponseType.returnedUserID.

Returns:
String

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.