Changes since
the last release

com.ebay.sdk.call
Class GetCategoryFeaturesCall

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

public class GetCategoryFeaturesCall
extends ApiCall

Wrapper class of the GetCategoryFeatures 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: CategoryID - Specifies the category for which you want to retrieve the feature settings.

Specify a CategoryID, set DetailLevel to ReturnAll, and set ViewAllNodes to true to return the default site settings, the overrides for the specified category, plus all the child categories that have overrides on the features they inherit.

If you also set AllFeaturesForCategory to true, eBay returns the site defaults, plus all the settings for the specified category. Child category information is not returned in this case.

If CategoryID is not specified, eBay returns the feature settings for the site. To return details on all categories that have overrides on the properties they inherit, set DetailLevel to ReturnAll, and set ViewAllNodes to true. If you also set AllFeaturesForCategory to true, eBay returns only the site defaults with no child category information.
Input property: LevelLimit - This field is used if the user wants to control the maximum depth of the category hierarchy to retrieve, or in other words, how many levels of eBay categories that are returned in the response. If this field is omitted, and no CategoryID is specified, eBay feature metadata for every eBay category from the root on down will be returned. If this field is omitted, but a CategoryID is specified, the specified category and all of its children (down to the leaf categories) are returned.

If the CategoryID field is not used, but the LevelLimit field is used and set to 1, eBay feature metadata is only returned for the top-level categories (also known as L1 categories).
Input property: ViewAllNodes - You must set DetailLevel to ReturnAll in order to correctly populate the response when you set ViewAllNodes to true. In this case, eBay returns the site defaults along with all the categories that override the feature settings they inherit. Here, each Category container shows only the features that it has overridden from its parent node.

If you also specify a CategoryID, eBay returns the details for that category, along with containers for each of its child categories that have feature overrides.

Note that if ViewAllNodes is set to false (the default) and DetailLevel is set to ReturnAll, eBay returns only the leaf categories that have features that override the settings they inherit. In this case, the call will not return leaf categories that do not have overrides.
Input property: FeatureIDs - Use this field if you want to know if specific features are enabled at the site or root category level. Multiple FeatureID elements can be used in the request. If no FeatureID elements are used, the call retrieves data for all features, as applicable to the other request parameters.
Input property: AllFeaturesForCategory - Use this switch to view all of the feature settings for a specific category. All feature settings are returned, regardless of the site default settings. This element works in conjunction with CategoryID--refer to the notes for that element for more details.

If you also set FeatureID, eBay returns the status of the specified features only, for the specified category.
Output property: ReturnedCategoryVersion - Returns the current version of the set of feature meta-data. Compare this value to the version of the last version you downloaded to determine whether the data may have changed.
Output property: ReturnUpdateTime - Gives the time in GMT that the feature flags for the category hierarchy were last updated.
Output property: ReturnedCategory - A category whose feature settings are different from the settings of its parent category.

For example, suppose there is a branch of the category tree with 5 category levels (L1, L2, L3, L4, and L5). Suppose the feature settings for SiteDefaults, L1, L4, and L5 are all "A", and the settings for L2 and L3 are "B". In this case:
L1's settings (A) match the site default, so L1 is not returned.
L2's settings (B) are different from L1's, so L2 is returned.
L3's settings (B) are the same as L2's, so L3 is not returned
L4's settings (A) are different from L3's, so L4 is returned
L5's settings (A) are the same as L4's, so L5 is not returned.

If you specified a particular FeatureID in the request, this field only returns feature settings for that feature. Only returned when the category is different from its parent. If the category has children and they aren't returned, it means the children inherit the category's feature settings.
Output property: ReturnedSiteDefaults - Returns the feature settings defined for most categories on the site. Most categories share these settings. However, some categories can override some settings, as indicated in the Category nodes (if any).
Output property: ReturnedFeatureDefinitions - Returns definitions of the various features on the site, or the features you requested in FeatureID (if any). Each feature has a node within FeatureDefinitions.

Version:
1.0
Author:
Ron Murphy

Field Summary
 
Fields inherited from class com.ebay.sdk.ApiCall
apiException, sendReqListeners
 
Constructor Summary
GetCategoryFeaturesCall()
          Constructor.
GetCategoryFeaturesCall(ApiContext apiContext)
          Constructor.
 
Method Summary
 java.lang.Boolean getAllFeaturesForCategory()
          Gets the GetCategoryFeaturesRequestType.allFeaturesForCategory.
 void getCategoryFeatures()
          Returns information about the features that are applicable to different categories, such as listing durations, shipping term requirements, and Best Offer support.
 java.lang.String getCategoryID()
          Gets the GetCategoryFeaturesRequestType.categoryID.
 FeatureIDCodeType[] getFeatureIDs()
          Gets the GetCategoryFeaturesRequestType.featureIDs.
 java.lang.Integer getLevelLimit()
          Gets the GetCategoryFeaturesRequestType.levelLimit.
 CategoryFeatureType[] getReturnedCategory()
          Valid after executing the API.
 java.lang.String getReturnedCategoryVersion()
          Valid after executing the API.
 FeatureDefinitionsType getReturnedFeatureDefinitions()
          Valid after executing the API.
 SiteDefaultsType getReturnedSiteDefaults()
          Valid after executing the API.
 java.util.Calendar getReturnUpdateTime()
          Valid after executing the API.
 java.lang.Boolean getViewAllNodes()
          Gets the GetCategoryFeaturesRequestType.viewAllNodes.
 void setAllFeaturesForCategory(java.lang.Boolean allFeaturesForCategory)
          Sets the GetCategoryFeaturesRequestType.allFeaturesForCategory.
 void setCategoryID(java.lang.String categoryID)
          Sets the GetCategoryFeaturesRequestType.categoryID.
 void setFeatureIDs(FeatureIDCodeType[] featureIDs)
          Sets the GetCategoryFeaturesRequestType.featureIDs.
 void setLevelLimit(java.lang.Integer levelLimit)
          Sets the GetCategoryFeaturesRequestType.levelLimit.
 void setViewAllNodes(java.lang.Boolean viewAllNodes)
          Sets the GetCategoryFeaturesRequestType.viewAllNodes.
 
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

GetCategoryFeaturesCall

public GetCategoryFeaturesCall()
Constructor.


GetCategoryFeaturesCall

public GetCategoryFeaturesCall(ApiContext apiContext)
Constructor.

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

getCategoryFeatures

public void getCategoryFeatures()
                         throws ApiException,
                                SdkException,
                                java.lang.Exception
Returns information about the features that are applicable to different categories, such as listing durations, shipping term requirements, and Best Offer support.

Throws:
ApiException
SdkException
java.lang.Exception

getAllFeaturesForCategory

public java.lang.Boolean getAllFeaturesForCategory()
Gets the GetCategoryFeaturesRequestType.allFeaturesForCategory.

Returns:
Boolean

setAllFeaturesForCategory

public void setAllFeaturesForCategory(java.lang.Boolean allFeaturesForCategory)
Sets the GetCategoryFeaturesRequestType.allFeaturesForCategory.

Parameters:
allFeaturesForCategory - Boolean

getCategoryID

public java.lang.String getCategoryID()
Gets the GetCategoryFeaturesRequestType.categoryID.

Returns:
String

setCategoryID

public void setCategoryID(java.lang.String categoryID)
Sets the GetCategoryFeaturesRequestType.categoryID.

Parameters:
categoryID - String

getFeatureIDs

public FeatureIDCodeType[] getFeatureIDs()
Gets the GetCategoryFeaturesRequestType.featureIDs.

Returns:
FeatureIDCodeType[]

setFeatureIDs

public void setFeatureIDs(FeatureIDCodeType[] featureIDs)
Sets the GetCategoryFeaturesRequestType.featureIDs.

Parameters:
featureIDs - FeatureIDCodeType[]

getLevelLimit

public java.lang.Integer getLevelLimit()
Gets the GetCategoryFeaturesRequestType.levelLimit.

Returns:
Integer

setLevelLimit

public void setLevelLimit(java.lang.Integer levelLimit)
Sets the GetCategoryFeaturesRequestType.levelLimit.

Parameters:
levelLimit - Integer

getViewAllNodes

public java.lang.Boolean getViewAllNodes()
Gets the GetCategoryFeaturesRequestType.viewAllNodes.

Returns:
Boolean

setViewAllNodes

public void setViewAllNodes(java.lang.Boolean viewAllNodes)
Sets the GetCategoryFeaturesRequestType.viewAllNodes.

Parameters:
viewAllNodes - Boolean

getReturnUpdateTime

public java.util.Calendar getReturnUpdateTime()
Valid after executing the API. Gets the returned GetCategoryFeaturesResponseType.returnUpdateTime.

Returns:
Calendar

getReturnedCategory

public CategoryFeatureType[] getReturnedCategory()
Valid after executing the API. Gets the returned GetCategoryFeaturesResponseType.returnedCategory.

Returns:
CategoryFeatureType[]

getReturnedCategoryVersion

public java.lang.String getReturnedCategoryVersion()
Valid after executing the API. Gets the returned GetCategoryFeaturesResponseType.returnedCategoryVersion.

Returns:
String

getReturnedFeatureDefinitions

public FeatureDefinitionsType getReturnedFeatureDefinitions()
Valid after executing the API. Gets the returned GetCategoryFeaturesResponseType.returnedFeatureDefinitions.

Returns:
FeatureDefinitionsType

getReturnedSiteDefaults

public SiteDefaultsType getReturnedSiteDefaults()
Valid after executing the API. Gets the returned GetCategoryFeaturesResponseType.returnedSiteDefaults.

Returns:
SiteDefaultsType

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.