Package de.hybris.platform.personalizationservices.variation

Interface CxVariationService

  • All Known Implementing Classes:
    DefaultCxVariationService
    public interface CxVariationService
    Service for operations on variations

    • Method Detail

      • createVariation

        CxVariationModel createVariation​(CxVariationModel variation,
                                 CxCustomizationModel customization,
                                 java.lang.Integer rank)
        Creates variation for given customization
        Parameters:
        variation - Variation to create
        customization - Customization for which variation should be created
        rank - Position in variation list for customization.Parameter is optional. If null customization should be added at some default position.
        Returns:
        created variation

      • getVariation

        java.util.Optional<CxVariationModel> getVariation​(java.lang.String code,
                                                  CxCustomizationModel customization)
        Retrieves variation with given code from given customization
        Parameters:
        code - identifier of variation
        customization - customization containing variations
        Returns:
        variation with given code or optional.empty

      • getVariations

        java.util.Collection<CxVariationModel> getVariations​(java.util.Collection<CxVariationKey> key,
                                                     CatalogVersionModel catalogVersion)
        Retrieves variations list for given key list
        Parameters:
        key - list of identifiers of variations
        catalogVersion - catalog version
        Returns:
        collection of variation with given keys or Collections.EMPTY_LIST

      • getVariations

        SearchPageData<CxVariationModel> getVariations​(CxCustomizationModel customization,
                                               java.util.Map<java.lang.String,​java.lang.String> params,
                                               SearchPageData<?> pagination)
        Retrieves variations fulfilling given parameters from given customization.
        Parameters:
        customization - customization containing variations
        params - query parameters
        pagination - holder of pagination data and sort options
        Returns:
        SearchResult with variations fulfilling given parameters

      • getActiveVariations

        java.util.List<CxVariationModel> getActiveVariations​(UserModel user,
                                                     CatalogVersionModel catalogVersion)
        Retrieves active variations for given user
        Parameters:
        user - for which variations will be returned
        catalogVersion - for which variations will be returned
        Returns:
        Collection of active variations (may be empty).