Package de.hybris.platform.sap.productconfig.runtime.cps.masterdata.service

Interface ConfigurationMasterDataService

All Known Implementing Classes:
ConfigurationMasterDataServiceImpl
public interface ConfigurationMasterDataService
Master data service for filling config model.

  • Method Details

    • getItemName

      String getItemName(String kbId, String id, String type)
      Gets localised name for item
      Parameters:
      kbId - id of the knowledgebase
      id - id of the item
      type - type of the item
      Returns:
      localised name of the item

    • getGroupName

      String getGroupName(String kbId, String itemKey, String itemType, String groupId)
      Gets localised name for group. In case we are requesting the group name for class nodes, the class name will be returned as the class node doesn't carry UI groups, except for the 'general' dummy group
      Parameters:
      kbId - id of the knowledgebase
      itemKey - id of the product or class
      itemType - Either SapproductconfigruntimecpsConstants.ITEM_TYPE_MARA or SapproductconfigruntimecpsConstants.ITEM_TYPE_KLAH
      groupId - id of the group. Not relevant for class nodes
      Returns:
      localised name of the group

    • isProductMultilevel

      boolean isProductMultilevel(String kbId, String productId)
      Gives information whether product is multilevel
      Parameters:
      kbId - id of the knowledgebase
      productId - id of the product
      Returns:
      whether product is multilevel

    • getCharacteristic

      CPSMasterDataCharacteristicContainer getCharacteristic(String kbId, String characteristicId)
      Gets localised master data for characteristic
      Parameters:
      kbId - id of the knowledgebase
      characteristicId - id of the characteristic
      Returns:
      localised master data of the characteristic

    • getValueName

      String getValueName(String kbId, String characteristicId, String valueId)
      Gets localised name for value
      Parameters:
      kbId - id of the knowledgebase
      characteristicId - id of the characteristic
      valueId - id of the value
      Returns:
      localised name of the value

    • getValueDescription

      String getValueDescription(String kbId, String characteristicId, String valueId)
      Gets localised description for value
      Parameters:
      kbId - id of the knowledgebase
      characteristicId - id of the characteristic
      valueId - id of the value
      Returns:
      localised description of the value

    • getGroupCharacteristicIDs

      List<String> getGroupCharacteristicIDs(String kbId, String itemKey, String itemType, String groupId)
      Gets characteristic ids for group. In case we are requesting the characteristics for class nodes, all characteristic assigned to the class node will be returned as the class node does not carry any group besides the 'general' dummy group
      Parameters:
      kbId - id of the knowledgebase
      itemKey - id of the product or a class node
      itemType - Either SapproductconfigruntimecpsConstants.ITEM_TYPE_MARA or SapproductconfigruntimecpsConstants.ITEM_TYPE_KLAH
      groupId - id of the group. Not relevant for class nodes
      Returns:
      list of characteristic ids belonging to the group

    • getMasterData

      CPSMasterDataKnowledgeBaseContainer getMasterData(String kbId)
      Get master data by KB id
      Parameters:
      kbId - id of the knowledgebase
      Returns:
      knowledgebase data for the given id

    • getFallbackMasterData

      CPSMasterDataKnowledgeBaseContainer getFallbackMasterData(String kbId)
      Get fallback master data by KB id if fallback locale is maintained for current locale and fallback is enabled. Otherwise returns null.
      Parameters:
      kbId - id of the knowledgebase
      Returns:
      fallback knowledgebase data for the given id

    • getValuePricingKey

      String getValuePricingKey(String kbId, String productId, String characteristicId, String valueId)
      Get pricing key for value
      Parameters:
      kbId - id of the knowledgebase
      productId - id of the product
      characteristicId - id of the characteristic
      valueId - id of the value
      Returns:
      pricing key for the given value

    • getSpecificPossibleValueIds

      Set<String> getSpecificPossibleValueIds(String kbId, String itemKey, String itemType, String characteristicId)
      Get all specific (that have a variant condition) possible value ids for a given characteristic. For class nodes, which don't carry variant key assignments, an empty Set is returned
      Parameters:
      kbId - id of the knowledgebase
      itemKey - id of the product of of a class node
      itemType - Either SapproductconfigruntimecpsConstants.ITEM_TYPE_MARA or SapproductconfigruntimecpsConstants.ITEM_TYPE_KLAH
      characteristicId - id of the characteristic
      Returns:
      list of possible value ids

    • getPossibleValueIds

      Set<String> getPossibleValueIds(String kbId, String characteristicId)
      Get all possible value ids for a given characteristic
      Parameters:
      kbId - id of the knowledgebase
      productId - id of the product
      characteristicId - id of the characteristic
      Returns:
      list of possible value ids

    • isCharacteristicNumeric

      boolean isCharacteristicNumeric(String kbId, String csticId)
      Checks if a characteristic is numeric
      Parameters:
      kbId - Id of the knowledgebase
      csticId - Id of the characteristic
      Returns:
      whether characteristic is numeric

    • getKbBuildNumber

      Integer getKbBuildNumber(String kbId)
      Retrieves the build number for the specified knowledgebase id
      Parameters:
      kbId - Id of the knowledgebase
      Returns:
      build number of the knowledgebase

    • removeCachedKb

      void removeCachedKb(String kbId)
      Removes the knowledgebase from the hybris cache in order to force a reload from service
      Parameters:
      kbId - Id of the knowledgebase