Examples of com.ebay.sdk.call.GetCategoryFeaturesCall

com.ebay.sdk.call.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.

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

    this.FILE_PREFIX = "AllCatFeatures";
  }
  
  @Override
  protected String getLastUpdateTime() throws Exception {
    GetCategoryFeaturesCall api = new GetCategoryFeaturesCall(apiContext);
    GetCategoryFeaturesRequestType req = new GetCategoryFeaturesRequestType();
    //we only need 'UpdateTime' field
    //req.setOutputSelector(new String[]{"UpdateTime"});
    //workaround, use CategoryVersion instead of UpdateTime here
    req.setOutputSelector(new String[]{"CategoryVersion"});
    api.execute(req);
    GetCategoryFeaturesResponseType resp = (GetCategoryFeaturesResponseType) api.execute(req);
//    Date date = resp.getUpdateTime().getTime();
//    SimpleDateFormat df = new SimpleDateFormat("yyyy_MM_dd_hh_mm_ss");
//    String time = df.format(date);
    return resp.getCategoryVersion();
  }

View Full Code Here

  }


  @Override
  protected Object individualCall() throws Exception {
    //get all category features for a given site
      GetCategoryFeaturesCall apiCall = new GetCategoryFeaturesCall(apiContext);
      FeatureIDCodeType[] featureIds = new FeatureIDCodeType[]{
          FeatureIDCodeType.LISTING_DURATIONS,
          FeatureIDCodeType.ITEM_SPECIFICS_ENABLED,
          FeatureIDCodeType.RETURN_POLICY_ENABLED,
          FeatureIDCodeType.PAYMENT_METHODS,
          FeatureIDCodeType.CONDITION_ENABLED,
          FeatureIDCodeType.CONDITION_VALUES
      };
      apiCall.setFeatureIDs(featureIds);


      // Set detail level.
      DetailLevelCodeType[] detailLevels = new DetailLevelCodeType[] {DetailLevelCodeType.RETURN_ALL};
      apiCall.setDetailLevel(detailLevels);
      apiCall.setViewAllNodes(true);
      //execute call
      apiCall.getCategoryFeatures();
      return apiCall.getResponseObject();
  }

View Full Code Here

       _categoryVersionsBySite.put(_site, _categoryVersion);
     }
   }
   
   private void getCategoryFeatures() throws SdkException, Exception {
     GetCategoryFeaturesCall api = new GetCategoryFeaturesCall(_apiContext);
     DetailLevelCodeType[] detailLevels = new DetailLevelCodeType[] {DetailLevelCodeType.RETURN_ALL};
     api.setDetailLevel(detailLevels);
     api.setCategoryID(_categoryID);
     api.setLevelLimit(_levelLimit);
     api.setViewAllNodes(_viewAllNodes);
     api.setFeatureIDs(_featureIDs);


     // Make API call.
     api.getCategoryFeatures();
     _categoryFeatures = api.getReturnedCategory();
     _categoryVersion = api.getReturnedCategoryVersion();
     _siteDefaults = api.getReturnedSiteDefaults();
     _siteFeatures = api.getReturnedFeatureDefinitions();
   }

View Full Code Here

TOP

Related Classes of com.ebay.sdk.call.GetCategoryFeaturesCall

com.ebay.sdk.helper.cache.FeaturesDownloader

com.ebay.sdk.helper.GetCategoryFeaturesHelper

All source code are property of their respective owners. Java is a trademark of Sun Microsystems, Inc and owned by ORACLE Inc. Contact coftware#gmail.com.