Package de.hybris.platform.cmsfacades.types.service

Interface ComponentTypeStructure

All Known Implementing Classes:
DefaultComponentTypeStructure
public interface ComponentTypeStructure
Represents meta-information about a ComposedTypeModel and the populators required to convert this information to a ComponentTypeData.

  • Method Details

    • getTypecode

      String getTypecode()
      Get the typecode identifying the ComposedTypeModel.
      Returns:
      the typecode

    • setTypecode

      void setTypecode(String typecode)
      Sets the typecode identifying the ComposedTypeModel.
      Parameters:
      typecode - - the typecode

    • getCategory

      StructureTypeCategory getCategory()
      Get the category in which this type belongs to. By default and for backwards compatibility, all categories are set to COMPONENT enum type.
      Returns:
      the category

    • setCategory

      void setCategory(StructureTypeCategory category)
      Sets the category for this component type. By default, if the category is not set, the category is of the COMPONENT enum type.
      Parameters:
      category -

    • getTypeDataClass

      @Deprecated(since="1811", forRemoval=true) Class getTypeDataClass()
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 1811, no longer needed
      Get the concrete Type Data class representing this type
      Returns:
      the concrete class that represents the Type Structure

    • setTypeDataClass

      @Deprecated(since="1811", forRemoval=true) void setTypeDataClass(Class typeDataClass)
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 1811, no longer needed
      Optional. Sets the concrete Type Data class representing this type.
      Parameters:
      typeDataClass - The concrete class that represents the Type Structure

    • getAttributes

      Set<ComponentTypeAttributeStructure> getAttributes()
      Get the attributes that should be considered by the ComponentTypeStructure.
      Returns:
      the attributes or an empty set

    • getPopulators

      List<Populator<ComposedTypeModel,ComponentTypeData>> getPopulators()
      Get the populators to be used when converting the representing ComposedTypeModel to a ComponentTypeData.
      Returns:
      the populators

    • setPopulators

      void setPopulators(List<Populator<ComposedTypeModel,ComponentTypeData>> populators)
      Sets the populators to be used when converting the representing ComposedTypeModel to a ComponentTypeData.
      Parameters:
      populators - - the populators