Package de.hybris.platform.catalog

Interface KeywordService

  • All Known Implementing Classes:
    DefaultKeywordService
    public interface KeywordService
    Provides access to Keyword.

    A keyword can be used to allow convenient searches on catalog elements. Keywords are bound to the catalog elements CategoryModel and ProductModel.

    Spring Bean ID:
    keywordService

    • Method Detail

      • getKeyword

        KeywordModel getKeyword​(CatalogVersionModel catalogVersion,
                        java.lang.String keywordValue)
        Returns the Keyword for the specified keyword value and CatalogVersion.
        Parameters:
        catalogVersion - The CatalogVersion the Keyword belongs to.
        keywordValue - The value of the searched Keyword.
        Returns:
        The matching Keyword.
        Throws:
        UnknownIdentifierException - when keyword not found.
        AmbiguousIdentifierException - when more then one found.

      • getKeyword

        KeywordModel getKeyword​(java.lang.String typeCode,
                        CatalogVersionModel catalogVersion,
                        java.lang.String keywordValue)
        Returns the Keyword for the specified keyword value and CatalogVersion.
        Parameters:
        typeCode - The code of type (or subtype) of keyword to allow to search for subclasses
        catalogVersion - The CatalogVersion the Keyword belongs to.
        keywordValue - The value of the searched Keyword.
        Returns:
        The matching Keyword.
        Throws:
        UnknownIdentifierException - when keyword not found.
        AmbiguousIdentifierException - when more then one found.