Changes since
the last release

com.ebay.sdk.call
Class GetCategoryMappingsCall

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

public class GetCategoryMappingsCall
extends ApiCall

Wrapper class of the GetCategoryMappings 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: CategoryVersion - A version of the category mapping for the site. Filters out data from the call to return only the category mappings for which the data has changed since the specified version. If not specified, all category mappings are returned. Typically, an application passes the version value of the last set of category mappings that the application stored locally. The latest version value is not necessarily greater than the previous value that was returned. Therefore, when comparing versions, only compare whether the value has changed.
Output property: ReturnedCategoryMapping - Mapping between an old category ID and an active category ID. Returned when category mappings exist and the value of CategoryVersion is different from the current version on the site.
Output property: ReturnedCategoryVersion - Version value assigned to the current category mapping data for the site. Compare this value to the version value the application stored with the mappings the last time the application executed the call. If the versions are the same, the data has not changed since the last time the data was retrieved and stored.

Version:
1.0
Author:
Ron Murphy

Field Summary
 
Fields inherited from class com.ebay.sdk.ApiCall
apiException, sendReqListeners
 
Constructor Summary
GetCategoryMappingsCall()
          Constructor.
GetCategoryMappingsCall(ApiContext apiContext)
          Constructor.
 
Method Summary
 void getCategoryMappings()
          Retrieves a map of old category IDs and corresponding active category IDs defined for the site to which the request is sent.
 String getCategoryVersion()
          Gets the GetCategoryMappingsRequestType.categoryVersion.
 CategoryMappingType[] getReturnedCategoryMapping()
          Valid after executing the API.
 String getReturnedCategoryVersion()
          Valid after executing the API.
 void setCategoryVersion(String categoryVersion)
          Sets the GetCategoryMappingsRequestType.categoryVersion.
 
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

GetCategoryMappingsCall

public GetCategoryMappingsCall()
Constructor.


GetCategoryMappingsCall

public GetCategoryMappingsCall(ApiContext apiContext)
Constructor.

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

getCategoryMappings

public void getCategoryMappings()
                         throws ApiException,
                                SdkException,
                                Exception
Retrieves a map of old category IDs and corresponding active category IDs defined for the site to which the request is sent.

Throws:
ApiException
SdkException
Exception

getCategoryVersion

public String getCategoryVersion()
Gets the GetCategoryMappingsRequestType.categoryVersion.

Returns:
String

setCategoryVersion

public void setCategoryVersion(String categoryVersion)
Sets the GetCategoryMappingsRequestType.categoryVersion.

Parameters:
categoryVersion - String

getReturnedCategoryMapping

public CategoryMappingType[] getReturnedCategoryMapping()
Valid after executing the API. Gets the returned GetCategoryMappingsResponseType.returnedCategoryMapping.

Returns:
CategoryMappingType[]

getReturnedCategoryVersion

public String getReturnedCategoryVersion()
Valid after executing the API. Gets the returned GetCategoryMappingsResponseType.returnedCategoryVersion.

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.