com.ebay.sdk.call.GetCategoryFeaturesCall Maven / Gradle / Ivy
/*
Copyright (c) 2013 eBay, Inc.
This program is licensed under the terms of the eBay Common Development and
Distribution License (CDDL) Version 1.0 (the "License") and any subsequent version
thereof released by eBay. The then-current version of the License can be found
at http://www.opensource.org/licenses/cddl1.php and in the eBaySDKLicense file that
is under the eBay SDK ../docs directory.
*/
package com.ebay.sdk.call;
import java.lang.Boolean;
import java.lang.Integer;
import java.lang.String;
import java.util.Calendar;
import com.ebay.sdk.*;
import com.ebay.soap.eBLBaseComponents.*;
/**
* 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 - A level of depth in the category hierarchy. Retrieves all category
* nodes with a CategoryLevel less than or equal to the LevelLimit
* value.
*
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.
*
* @author Ron Murphy
* @version 1.0
*/
public class GetCategoryFeaturesCall extends com.ebay.sdk.ApiCall
{
private String categoryID = null;
private Integer levelLimit = null;
private Boolean viewAllNodes = null;
private FeatureIDCodeType[] featureIDs = null;
private Boolean allFeaturesForCategory = null;
private String returnedCategoryVersion=null;
private Calendar returnUpdateTime=null;
private CategoryFeatureType[] returnedCategory=null;
private SiteDefaultsType returnedSiteDefaults=null;
private FeatureDefinitionsType returnedFeatureDefinitions=null;
/**
* Constructor.
*/
public GetCategoryFeaturesCall() {
}
/**
* Constructor.
* @param apiContext The ApiContext object to be used to make the call.
*/
public GetCategoryFeaturesCall(ApiContext apiContext) {
super(apiContext);
}
/**
* Returns information about the features that are applicable to different categories,
* such as listing durations, shipping term requirements, and Best Offer support.
*
*
* @throws ApiException
* @throws SdkException
* @throws Exception
* @return The void object.
*/
public void getCategoryFeatures()
throws com.ebay.sdk.ApiException, com.ebay.sdk.SdkException, java.lang.Exception
{
GetCategoryFeaturesRequestType req;
req = new GetCategoryFeaturesRequestType();
req.setDetailLevel(this.getDetailLevel());
if (this.categoryID != null)
req.setCategoryID(this.categoryID);
if (this.levelLimit != null)
req.setLevelLimit(this.levelLimit);
if (this.viewAllNodes != null)
req.setViewAllNodes(this.viewAllNodes);
if (this.featureIDs != null)
req.setFeatureID(this.featureIDs);
if (this.allFeaturesForCategory != null)
req.setAllFeaturesForCategory(this.allFeaturesForCategory);
GetCategoryFeaturesResponseType resp = (GetCategoryFeaturesResponseType) execute(req);
this.returnedCategoryVersion = resp.getCategoryVersion();
this.returnUpdateTime = resp.getUpdateTime();
this.returnedCategory = resp.getCategory();
this.returnedSiteDefaults = resp.getSiteDefaults();
this.returnedFeatureDefinitions = resp.getFeatureDefinitions();
}
/**
* Gets the GetCategoryFeaturesRequestType.allFeaturesForCategory.
* @return Boolean
*/
public Boolean getAllFeaturesForCategory()
{
return this.allFeaturesForCategory;
}
/**
* Sets the GetCategoryFeaturesRequestType.allFeaturesForCategory.
* @param allFeaturesForCategory Boolean
*/
public void setAllFeaturesForCategory(Boolean allFeaturesForCategory)
{
this.allFeaturesForCategory = allFeaturesForCategory;
}
/**
* Gets the GetCategoryFeaturesRequestType.categoryID.
* @return String
*/
public String getCategoryID()
{
return this.categoryID;
}
/**
* Sets the GetCategoryFeaturesRequestType.categoryID.
* @param categoryID String
*/
public void setCategoryID(String categoryID)
{
this.categoryID = categoryID;
}
/**
* Gets the GetCategoryFeaturesRequestType.featureIDs.
* @return FeatureIDCodeType[]
*/
public FeatureIDCodeType[] getFeatureIDs()
{
return this.featureIDs;
}
/**
* Sets the GetCategoryFeaturesRequestType.featureIDs.
* @param featureIDs FeatureIDCodeType[]
*/
public void setFeatureIDs(FeatureIDCodeType[] featureIDs)
{
this.featureIDs = featureIDs;
}
/**
* Gets the GetCategoryFeaturesRequestType.levelLimit.
* @return Integer
*/
public Integer getLevelLimit()
{
return this.levelLimit;
}
/**
* Sets the GetCategoryFeaturesRequestType.levelLimit.
* @param levelLimit Integer
*/
public void setLevelLimit(Integer levelLimit)
{
this.levelLimit = levelLimit;
}
/**
* Gets the GetCategoryFeaturesRequestType.viewAllNodes.
* @return Boolean
*/
public Boolean getViewAllNodes()
{
return this.viewAllNodes;
}
/**
* Sets the GetCategoryFeaturesRequestType.viewAllNodes.
* @param viewAllNodes Boolean
*/
public void setViewAllNodes(Boolean viewAllNodes)
{
this.viewAllNodes = viewAllNodes;
}
/**
* Valid after executing the API.
* Gets the returned GetCategoryFeaturesResponseType.returnUpdateTime.
*
* @return Calendar
*/
public Calendar getReturnUpdateTime()
{
return this.returnUpdateTime;
}
/**
* Valid after executing the API.
* Gets the returned GetCategoryFeaturesResponseType.returnedCategory.
*
* @return CategoryFeatureType[]
*/
public CategoryFeatureType[] getReturnedCategory()
{
return this.returnedCategory;
}
/**
* Valid after executing the API.
* Gets the returned GetCategoryFeaturesResponseType.returnedCategoryVersion.
*
* @return String
*/
public String getReturnedCategoryVersion()
{
return this.returnedCategoryVersion;
}
/**
* Valid after executing the API.
* Gets the returned GetCategoryFeaturesResponseType.returnedFeatureDefinitions.
*
* @return FeatureDefinitionsType
*/
public FeatureDefinitionsType getReturnedFeatureDefinitions()
{
return this.returnedFeatureDefinitions;
}
/**
* Valid after executing the API.
* Gets the returned GetCategoryFeaturesResponseType.returnedSiteDefaults.
*
* @return SiteDefaultsType
*/
public SiteDefaultsType getReturnedSiteDefaults()
{
return this.returnedSiteDefaults;
}
}