|
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
public class ApiCall
The base class of all API call classes (AddItemCall, GetItemCall, etc).
Each ApiCall object requires an ApiContext object to control the
common context under which the API call will be made.
Title:
Description:
Copyright: Copyright (c) 2004
Company: eBay Inc.
Field Summary | |
---|---|
protected ApiException |
apiException
Set the API exception object. |
protected EventListenerList |
sendReqListeners
|
Constructor Summary | |
---|---|
ApiCall()
Constructor. |
|
ApiCall(ApiContext apiContext)
Constructor. |
Method Summary | |
---|---|
void |
addDetailLevel(DetailLevelCodeType detail)
Add a detail level value to for call object. |
void |
addSendRequestListener(SendApiRequestListener l)
Add listener to filter the AbstractRequestType object right before it is sent to eBay server. |
AbstractResponseType |
execute(AbstractRequestType request)
Executing the API call. |
AbstractResponseType |
executeByApiName(String apiName,
AbstractRequestType request)
Executing the API call by providing API name string (e.g., AddItem, GetItem). |
ApiContext |
getApiContext()
Get the ApiContext object to be used. |
ApiException |
getApiException()
After making the API call, returns the ApiExceptin object of the call. |
BotBlockRequestType |
getBotBlock()
|
CallRetry |
getCallRetry()
Get the CallRetry object that is being used. |
DetailLevelCodeType[] |
getDetailLevel()
Get the DetailLevels of the API call. |
boolean |
getEnableCompression()
Determine if GZIP or DEFLATE compression is enabled for this ApiCall object. |
String |
getEndUserIP()
|
ErrorHandlingCodeType |
getErrorHandling()
|
String |
getInvocationID()
|
String |
getMessageID()
|
String[] |
getOutputSelector()
|
String |
getRequestXml()
After making the API call, returns the SOAP request Xml text. |
AbstractResponseType |
getResponseObject()
After calling Execute(), returns the AbstractResponseType object. |
String |
getResponseXml()
After making the API call, returns the SOAP response Xml text. |
SiteCodeType |
getSite()
Gets the eBay site that is the call is associated with. |
WarningLevelCodeType |
getWarningLevel()
|
boolean |
hasError()
After calling Exceute(), gets if there are errors returned from eBay API server. |
boolean |
hasWarning()
After calling Exceute(), gets if there are warnning returned from eBay API server. |
void |
removeSendRequestListener(SendApiRequestListener l)
Remove a listener. |
void |
setApiContext(ApiContext apiContext)
Set the ApiContext object to be used. |
void |
setBotBlock(BotBlockRequestType botBlock)
|
void |
setCallRetry(CallRetry callRetry)
Set the CallRetry object to be used. |
void |
setDetailLevel(DetailLevelCodeType[] detailLevel)
Set the DetaiLevels of the API call. |
void |
setEnableCompression(boolean enableCompression)
Sets to true to enable GZIP or DEFLATE compression for this ApiCall object. |
void |
setEndUserIP(String endUserIP)
|
void |
setErrorHandling(ErrorHandlingCodeType errorHandling)
|
void |
setInvocationID(String invocationID)
|
void |
setMessageID(String messageID)
|
void |
setOutputSelector(String[] outputSelector)
|
void |
setSite(SiteCodeType site)
Sets the eBay site that is the call is associated with. |
void |
setWarningLevel(WarningLevelCodeType warningLevel)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected EventListenerList sendReqListeners
protected ApiException apiException
Constructor Detail |
---|
public ApiCall()
public ApiCall(ApiContext apiContext)
apiContext
- The ApiContext object for the ApiCall object.Method Detail |
---|
public ApiContext getApiContext()
public void setApiContext(ApiContext apiContext)
apiContext
- The ApiContext object to be set to.public void addSendRequestListener(SendApiRequestListener l)
l
- SendApiRequestListenerpublic void removeSendRequestListener(SendApiRequestListener l)
l
- SendApiRequestListenerpublic DetailLevelCodeType[] getDetailLevel()
public void setDetailLevel(DetailLevelCodeType[] detailLevel)
detailLevel
- Array of DetailLevels to be set to.public void addDetailLevel(DetailLevelCodeType detail)
detail
- DetailLevelCodeTypepublic CallRetry getCallRetry()
public void setCallRetry(CallRetry callRetry)
callRetry
- The CallRetry object to use.public ApiException getApiException()
public boolean hasWarning()
public boolean hasError()
public String getRequestXml()
public String getResponseXml()
public SiteCodeType getSite()
public boolean getEnableCompression()
public void setSite(SiteCodeType site)
site
- SiteCodeTypepublic void setEnableCompression(boolean enableCompression)
enableCompression
- booleanpublic AbstractResponseType getResponseObject()
public AbstractResponseType execute(AbstractRequestType request) throws ApiException, SdkSoapException, SdkException
request
- The request object.
ApiException
SdkSoapException
SdkException
public AbstractResponseType executeByApiName(String apiName, AbstractRequestType request) throws ApiException, SdkSoapException, SdkException
apiName
- The name of the API call. e.g., addItem, getItem, etc.request
- The AbstractRequestType object.
ApiException
SdkSoapException
SdkException
public String[] getOutputSelector()
public void setOutputSelector(String[] outputSelector)
public String getMessageID()
public void setMessageID(String messageID)
public String getEndUserIP()
public void setEndUserIP(String endUserIP)
public String getInvocationID()
public void setInvocationID(String invocationID)
public WarningLevelCodeType getWarningLevel()
public void setWarningLevel(WarningLevelCodeType warningLevel)
public BotBlockRequestType getBotBlock()
public void setBotBlock(BotBlockRequestType botBlock)
public ErrorHandlingCodeType getErrorHandling()
public void setErrorHandling(ErrorHandlingCodeType errorHandling)
|
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.