Changes since
the last release

com.ebay.sdk.call
Class GetStoreCategoryUpdateStatusCall

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

public class GetStoreCategoryUpdateStatusCall
extends ApiCall

Wrapper class of the GetStoreCategoryUpdateStatus 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: TaskID - The unique identifier of an eBay Store Category hierarchy change task. A TaskID value is returned in the response of a successful SetStoreCategories call.

Note: Depending on the breadth of changes being made to an eBay Store Category hierarchy, it is is possible that the SetStoreCategories call will complete the task simultaneously with the call response. A seller will know if an eBay Store Category hierarchy task was completed simultaneously if the TaskID value is returned as 0, and the Status field is returned with a value of Complete. If the task was not completely simultaneously, the TaskID value will be a positive integer, and the Status field will show a value of InProgress or Pending.
Output property: ReturnedStatus - The enumeration value indicates the status of an update to the eBay Store Category hierarchy.

Version:
1.0
Author:
Ron Murphy

Field Summary
 
Fields inherited from class com.ebay.sdk.ApiCall
apiException, sendReqListeners
 
Constructor Summary
GetStoreCategoryUpdateStatusCall()
          Constructor.
GetStoreCategoryUpdateStatusCall(ApiContext apiContext)
          Constructor.
 
Method Summary
 TaskStatusCodeType getReturnedStatus()
          Valid after executing the API.
 TaskStatusCodeType getStoreCategoryUpdateStatus()
          This call is used to retrieve the status of an eBay Store Category hierarchy change that was made with a SetStoreCategories call.
 long getTaskID()
          Gets the GetStoreCategoryUpdateStatusRequestType.taskID.
 void setTaskID(long taskID)
          Sets the GetStoreCategoryUpdateStatusRequestType.taskID.
 
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

GetStoreCategoryUpdateStatusCall

public GetStoreCategoryUpdateStatusCall()
Constructor.


GetStoreCategoryUpdateStatusCall

public GetStoreCategoryUpdateStatusCall(ApiContext apiContext)
Constructor.

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

getStoreCategoryUpdateStatus

public TaskStatusCodeType getStoreCategoryUpdateStatus()
                                                throws ApiException,
                                                       SdkException,
                                                       java.lang.Exception
This call is used to retrieve the status of an eBay Store Category hierarchy change that was made with a SetStoreCategories call.

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

getTaskID

public long getTaskID()
Gets the GetStoreCategoryUpdateStatusRequestType.taskID.

Returns:
long

setTaskID

public void setTaskID(long taskID)
Sets the GetStoreCategoryUpdateStatusRequestType.taskID.

Parameters:
taskID - long

getReturnedStatus

public TaskStatusCodeType getReturnedStatus()
Valid after executing the API. Gets the returned GetStoreCategoryUpdateStatusResponseType.returnedStatus.

Returns:
TaskStatusCodeType

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.