Package de.hybris.platform.personalizationservices.customization

Interface CxCustomizationService

  • All Known Implementing Classes:
    DefaultCxCustomizationService
    public interface CxCustomizationService
    Service for basic operations on customizations

    • Method Detail

      • getCustomization

        java.util.Optional<CxCustomizationModel> getCustomization​(java.lang.String code,
                                                          CatalogVersionModel catalogVersion)
        Retrieves customization with given code defined for given catalog version
        Parameters:
        code - identifier of customization
        catalogVersion - Catalog version
        Returns:
        customization with given code or Optional.empty

      • getCustomizations

        java.util.List<CxCustomizationModel> getCustomizations​(CatalogVersionModel catalogVersion)
        Retrieves all customizations from the system
        Parameters:
        catalogVersion - Catalog version
        Returns:
        customizations from system or empty list if none

      • getCustomizations

        SearchPageData<CxCustomizationModel> getCustomizations​(CatalogVersionModel catalogVersion,
                                                       java.util.Map<java.lang.String,​java.lang.String> params,
                                                       SearchPageData<?> pagination)
        Retrieves all customizations from the system filtered by given params
        Parameters:
        catalogVersion - Catalog version
        params - parameters for filtering
        pagination - holder of pagination data and sort options
        Returns:
        customizations from system or empty list if none

      • getDefaultGroup

        CxCustomizationsGroupModel getDefaultGroup​(CatalogVersionModel catalogVersion)
        Returns default customization group for given catalog version
        Parameters:
        catalogVersion - Catalog version
        Returns:
        default customization group

      • createCustomization

        CxCustomizationModel createCustomization​(CxCustomizationModel customization,
                                         CxCustomizationsGroupModel customizationGroup,
                                         java.lang.Integer rank)
        Creates customization for given customization group
        Parameters:
        customization - Customization to be created
        customizationGroup - Customization group for which customization should be created
        rank - Position in customization list for group. Parameter is optional. If null customization should be added at some default position.
        Returns:
        Created customization

      • isDefaultGroup

        default boolean isDefaultGroup​(CatalogVersionModel catalogVersion)
        Checks if default customization group is created for catalog version
        Parameters:
        catalogVersion - Catalog version
        Returns:
        true if there is already customization group created for catalog version and false otherwise.