Changes since
the last release

com.ebay.sdk.call
Class SetStoreCategoriesCall

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

public class SetStoreCategoriesCall
extends ApiCall

Wrapper class of the SetStoreCategories 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: Action - Specifies the type of action (Add, Move, Delete, or Rename) to carry out for the specified eBay Store categories.
Input property: ItemDestinationCategoryID - Items can only be contained within child categories. A parent category cannot contain items. If adding, moving, or deleting categories displaces items, you must specify a destination child category under which the displaced items will be moved. The destination category must have no child categories.
Input property: DestinationParentCategoryID - When adding or moving store categories, specifies the category under which the listed categories will be located. To add or move categories to the top level, set the value to -999.
Input property: StoreCategories - Specifies the store categories on which to act.
Output property: ReturnedTaskID - The task ID associated with the category structure change request. For a simple change, the SetStoreCategories call is processed synchronously. That is, simple changes are made immediately and then the response is returned. For synchronous processing, the task ID in the response is 0. If the category structure changes affect many listings, the changes will be processed asynchronously and the task ID will be a positive number. Use the non-zero task ID with GetStoreCategoryUpdateStatus to monitor the status of asynchronously processed changes.
Output property: ReturnedStatus - When an eBay Store category structure change is processed synchronously, the status is returned as 'Complete' or 'Failed'. For asynchronously processed changes, the status is reported as 'InProgress' or 'Pending'. Use GetStoreCategoryUpdateStatus to monitor the status of asynchronously processed changes.
Output property: ReturnedCustomCategory - Contains hierarchy data for eBay Store categories that you have created/modified.

Version:
1.0
Author:
Ron Murphy

Field Summary
 
Fields inherited from class com.ebay.sdk.ApiCall
apiException, sendReqListeners
 
Constructor Summary
SetStoreCategoriesCall()
          Constructor.
SetStoreCategoriesCall(ApiContext apiContext)
          Constructor.
 
Method Summary
 StoreCategoryUpdateActionCodeType getAction()
          Gets the SetStoreCategoriesRequestType.action.
 java.lang.Long getDestinationParentCategoryID()
          Gets the SetStoreCategoriesRequestType.destinationParentCategoryID.
 java.lang.Long getItemDestinationCategoryID()
          Gets the SetStoreCategoriesRequestType.itemDestinationCategoryID.
 StoreCustomCategoryArrayType getReturnedCustomCategory()
          Valid after executing the API.
 TaskStatusCodeType getReturnedStatus()
          Valid after executing the API.
 long getReturnedTaskID()
          Valid after executing the API.
 StoreCustomCategoryArrayType getStoreCategories()
          Gets the SetStoreCategoriesRequestType.storeCategories.
 void setAction(StoreCategoryUpdateActionCodeType action)
          Sets the SetStoreCategoriesRequestType.action.
 void setDestinationParentCategoryID(java.lang.Long destinationParentCategoryID)
          Sets the SetStoreCategoriesRequestType.destinationParentCategoryID.
 void setItemDestinationCategoryID(java.lang.Long itemDestinationCategoryID)
          Sets the SetStoreCategoriesRequestType.itemDestinationCategoryID.
 long setStoreCategories()
          This call allows you to set or modify the category structure of an eBay Store.
 void setStoreCategories(StoreCustomCategoryArrayType storeCategories)
          Sets the SetStoreCategoriesRequestType.storeCategories.
 
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

SetStoreCategoriesCall

public SetStoreCategoriesCall()
Constructor.


SetStoreCategoriesCall

public SetStoreCategoriesCall(ApiContext apiContext)
Constructor.

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

setStoreCategories

public long setStoreCategories()
                        throws ApiException,
                               SdkException,
                               java.lang.Exception
This call allows you to set or modify the category structure of an eBay Store. Sellers must have an eBay Store subscription in order to use this call.

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

getAction

public StoreCategoryUpdateActionCodeType getAction()
Gets the SetStoreCategoriesRequestType.action.

Returns:
StoreCategoryUpdateActionCodeType

setAction

public void setAction(StoreCategoryUpdateActionCodeType action)
Sets the SetStoreCategoriesRequestType.action.

Parameters:
action - StoreCategoryUpdateActionCodeType

getDestinationParentCategoryID

public java.lang.Long getDestinationParentCategoryID()
Gets the SetStoreCategoriesRequestType.destinationParentCategoryID.

Returns:
Long

setDestinationParentCategoryID

public void setDestinationParentCategoryID(java.lang.Long destinationParentCategoryID)
Sets the SetStoreCategoriesRequestType.destinationParentCategoryID.

Parameters:
destinationParentCategoryID - Long

getItemDestinationCategoryID

public java.lang.Long getItemDestinationCategoryID()
Gets the SetStoreCategoriesRequestType.itemDestinationCategoryID.

Returns:
Long

setItemDestinationCategoryID

public void setItemDestinationCategoryID(java.lang.Long itemDestinationCategoryID)
Sets the SetStoreCategoriesRequestType.itemDestinationCategoryID.

Parameters:
itemDestinationCategoryID - Long

getStoreCategories

public StoreCustomCategoryArrayType getStoreCategories()
Gets the SetStoreCategoriesRequestType.storeCategories.

Returns:
StoreCustomCategoryArrayType

setStoreCategories

public void setStoreCategories(StoreCustomCategoryArrayType storeCategories)
Sets the SetStoreCategoriesRequestType.storeCategories.

Parameters:
storeCategories - StoreCustomCategoryArrayType

getReturnedCustomCategory

public StoreCustomCategoryArrayType getReturnedCustomCategory()
Valid after executing the API. Gets the returned SetStoreCategoriesResponseType.returnedCustomCategory.

Returns:
StoreCustomCategoryArrayType

getReturnedStatus

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

Returns:
TaskStatusCodeType

getReturnedTaskID

public long getReturnedTaskID()
Valid after executing the API. Gets the returned SetStoreCategoriesResponseType.returnedTaskID.

Returns:
long

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.