|
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
com.ebay.sdk.call.GetCategoryFeaturesCall
public class GetCategoryFeaturesCall
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.
CategoryID
- Specifies the category for which you want to retrieve the feature settings.
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.
1
, eBay feature metadata is only returned for the top-level categories (also known as L1 categories).
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.
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.
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.
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.
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.
ReturnUpdateTime
- Gives the time in GMT that the feature flags for the
category hierarchy were last updated.
ReturnedCategory
- A category whose feature settings are different from the settings of its parent category.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).
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.
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 java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public GetCategoryFeaturesCall()
public GetCategoryFeaturesCall(ApiContext apiContext)
apiContext
- The ApiContext object to be used to make the call.Method Detail |
---|
public void getCategoryFeatures() throws ApiException, SdkException, java.lang.Exception
ApiException
SdkException
java.lang.Exception
public java.lang.Boolean getAllFeaturesForCategory()
public void setAllFeaturesForCategory(java.lang.Boolean allFeaturesForCategory)
allFeaturesForCategory
- Booleanpublic java.lang.String getCategoryID()
public void setCategoryID(java.lang.String categoryID)
categoryID
- Stringpublic FeatureIDCodeType[] getFeatureIDs()
public void setFeatureIDs(FeatureIDCodeType[] featureIDs)
featureIDs
- FeatureIDCodeType[]public java.lang.Integer getLevelLimit()
public void setLevelLimit(java.lang.Integer levelLimit)
levelLimit
- Integerpublic java.lang.Boolean getViewAllNodes()
public void setViewAllNodes(java.lang.Boolean viewAllNodes)
viewAllNodes
- Booleanpublic java.util.Calendar getReturnUpdateTime()
public CategoryFeatureType[] getReturnedCategory()
public java.lang.String getReturnedCategoryVersion()
public FeatureDefinitionsType getReturnedFeatureDefinitions()
public SiteDefaultsType getReturnedSiteDefaults()
|
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.