Package de.hybris.platform.cms2lib.model.components

Class ProductListComponentModel

  • All Implemented Interfaces:
    java.io.Serializable
    public class ProductListComponentModel
extends SimpleCMSComponentModel
    Generated model class for type ProductListComponent first defined at extension cms2lib.
    See Also:
    Serialized Form

    • Field Detail

      • _TYPECODE

        public static final java.lang.String _TYPECODE
        Generated model type code constant.
        See Also:
        Constant Field Values

      • HEADLINE

        public static final java.lang.String HEADLINE
        Generated constant - Attribute key of ProductListComponent.headline attribute defined at extension cms2lib.
        See Also:
        Constant Field Values

      • CATEGORYCODE

        public static final java.lang.String CATEGORYCODE
        Generated constant - Attribute key of ProductListComponent.categoryCode attribute defined at extension cms2lib.
        See Also:
        Constant Field Values

      • PRODUCTSFROMCONTEXT

        public static final java.lang.String PRODUCTSFROMCONTEXT
        Generated constant - Attribute key of ProductListComponent.productsFromContext attribute defined at extension cms2lib.
        See Also:
        Constant Field Values

      • SEARCHQUERY

        public static final java.lang.String SEARCHQUERY
        Generated constant - Attribute key of ProductListComponent.searchQuery attribute defined at extension cms2lib.
        See Also:
        Constant Field Values

      • PAGINATION

        public static final java.lang.String PAGINATION
        Generated constant - Attribute key of ProductListComponent.pagination attribute defined at extension cms2lib.
        See Also:
        Constant Field Values

      • LAYOUT

        public static final java.lang.String LAYOUT
        Generated constant - Attribute key of ProductListComponent.layout attribute defined at extension cms2lib.
        See Also:
        Constant Field Values

      • PRODUCTCODES

        public static final java.lang.String PRODUCTCODES
        Generated constant - Attribute key of ProductListComponent.productCodes attribute defined at extension cms2lib.
        See Also:
        Constant Field Values

      • PRODUCTS

        public static final java.lang.String PRODUCTS
        Generated constant - Attribute key of ProductListComponent.products attribute defined at extension cms2lib.
        See Also:
        Constant Field Values

      • CATEGORY

        public static final java.lang.String CATEGORY
        Generated constant - Attribute key of ProductListComponent.category attribute defined at extension cms2lib.
        See Also:
        Constant Field Values

    • Constructor Detail

      • ProductListComponentModel

        public ProductListComponentModel()
        Generated constructor - Default constructor for generic creation.

      • ProductListComponentModel

        public ProductListComponentModel​(ItemModelContext ctx)
        Generated constructor - Default constructor for creation with existing context
        Parameters:
        ctx - the model context to be injected, must not be null

      • ProductListComponentModel

        @Deprecated(since="4.1.1",
            forRemoval=true)
public ProductListComponentModel​(CatalogVersionModel _catalogVersion,
                                 boolean _pagination,
                                 boolean _productsFromContext,
                                 java.lang.String _uid)
        Deprecated, for removal: This API element is subject to removal in a future version.
        since 4.1.1 Please use the default constructor without parameters
        Generated constructor - Constructor with all mandatory attributes.
        Parameters:
        _catalogVersion - initial attribute declared by type CMSItem at extension cms2
        _pagination - initial attribute declared by type ProductListComponent at extension cms2lib
        _productsFromContext - initial attribute declared by type ProductListComponent at extension cms2lib
        _uid - initial attribute declared by type CMSItem at extension cms2

      • ProductListComponentModel

        @Deprecated(since="4.1.1",
            forRemoval=true)
public ProductListComponentModel​(CatalogVersionModel _catalogVersion,
                                 ItemModel _owner,
                                 boolean _pagination,
                                 boolean _productsFromContext,
                                 java.lang.String _uid)
        Deprecated, for removal: This API element is subject to removal in a future version.
        since 4.1.1 Please use the default constructor without parameters
        Generated constructor - for all mandatory and initial attributes.
        Parameters:
        _catalogVersion - initial attribute declared by type CMSItem at extension cms2
        _owner - initial attribute declared by type Item at extension core
        _pagination - initial attribute declared by type ProductListComponent at extension cms2lib
        _productsFromContext - initial attribute declared by type ProductListComponent at extension cms2lib
        _uid - initial attribute declared by type CMSItem at extension cms2

    • Method Detail

      • getCategory

        @Accessor(qualifier="category",
          type=GETTER)
public CategoryModel getCategory()
        Generated method - Getter of the ProductListComponent.category attribute defined at extension cms2lib.
        Returns:
        the category

      • getCategoryCode

        @Accessor(qualifier="categoryCode",
          type=GETTER)
public java.lang.String getCategoryCode()
        Generated method - Getter of the ProductListComponent.categoryCode attribute defined at extension cms2lib.
        Returns:
        the categoryCode

      • getHeadline

        @Accessor(qualifier="headline",
          type=GETTER)
public java.lang.String getHeadline()
        Generated method - Getter of the ProductListComponent.headline attribute defined at extension cms2lib.
        Returns:
        the headline

      • getHeadline

        @Accessor(qualifier="headline",
          type=GETTER)
public java.lang.String getHeadline​(java.util.Locale loc)
        Generated method - Getter of the ProductListComponent.headline attribute defined at extension cms2lib.
        Parameters:
        loc - the value localization key
        Returns:
        the headline
        Throws:
        java.lang.IllegalArgumentException - if localization key cannot be mapped to data language

      • getProductCodes

        @Accessor(qualifier="productCodes",
          type=GETTER)
public java.util.List<java.lang.String> getProductCodes()
        Generated method - Getter of the ProductListComponent.productCodes attribute defined at extension cms2lib. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
        Returns:
        the productCodes

      • getProducts

        @Accessor(qualifier="products",
          type=GETTER)
public java.util.List<ProductModel> getProducts()
        Generated method - Getter of the ProductListComponent.products attribute defined at extension cms2lib. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
        Returns:
        the products

      • getSearchQuery

        @Accessor(qualifier="searchQuery",
          type=GETTER)
public java.lang.String getSearchQuery()
        Generated method - Getter of the ProductListComponent.searchQuery attribute defined at extension cms2lib.
        Returns:
        the searchQuery

      • getSearchQuery

        @Accessor(qualifier="searchQuery",
          type=GETTER)
public java.lang.String getSearchQuery​(java.util.Locale loc)
        Generated method - Getter of the ProductListComponent.searchQuery attribute defined at extension cms2lib.
        Parameters:
        loc - the value localization key
        Returns:
        the searchQuery
        Throws:
        java.lang.IllegalArgumentException - if localization key cannot be mapped to data language

      • isPagination

        @Accessor(qualifier="pagination",
          type=GETTER)
public boolean isPagination()
        Generated method - Getter of the ProductListComponent.pagination attribute defined at extension cms2lib.
        Returns:
        the pagination

      • isProductsFromContext

        @Accessor(qualifier="productsFromContext",
          type=GETTER)
public boolean isProductsFromContext()
        Generated method - Getter of the ProductListComponent.productsFromContext attribute defined at extension cms2lib.
        Returns:
        the productsFromContext

      • setCategory

        @Accessor(qualifier="category",
          type=SETTER)
public void setCategory​(CategoryModel value)
        Generated method - Setter of ProductListComponent.category attribute defined at extension cms2lib.
        Parameters:
        value - the category

      • setHeadline

        @Accessor(qualifier="headline",
          type=SETTER)
public void setHeadline​(java.lang.String value)
        Generated method - Setter of ProductListComponent.headline attribute defined at extension cms2lib.
        Parameters:
        value - the headline

      • setHeadline

        @Accessor(qualifier="headline",
          type=SETTER)
public void setHeadline​(java.lang.String value,
                        java.util.Locale loc)
        Generated method - Setter of ProductListComponent.headline attribute defined at extension cms2lib.
        Parameters:
        value - the headline
        loc - the value localization key
        Throws:
        java.lang.IllegalArgumentException - if localization key cannot be mapped to data language

      • setLayout

        @Accessor(qualifier="layout",
          type=SETTER)
public void setLayout​(ProductListLayouts value)
        Generated method - Setter of ProductListComponent.layout attribute defined at extension cms2lib.
        Parameters:
        value - the layout

      • setPagination

        @Accessor(qualifier="pagination",
          type=SETTER)
public void setPagination​(boolean value)
        Generated method - Setter of ProductListComponent.pagination attribute defined at extension cms2lib.
        Parameters:
        value - the pagination

      • setProducts

        @Accessor(qualifier="products",
          type=SETTER)
public void setProducts​(java.util.List<ProductModel> value)
        Generated method - Setter of ProductListComponent.products attribute defined at extension cms2lib.
        Parameters:
        value - the products

      • setProductsFromContext

        @Accessor(qualifier="productsFromContext",
          type=SETTER)
public void setProductsFromContext​(boolean value)
        Generated method - Setter of ProductListComponent.productsFromContext attribute defined at extension cms2lib.
        Parameters:
        value - the productsFromContext

      • setSearchQuery

        @Accessor(qualifier="searchQuery",
          type=SETTER)
public void setSearchQuery​(java.lang.String value)
        Generated method - Setter of ProductListComponent.searchQuery attribute defined at extension cms2lib.
        Parameters:
        value - the searchQuery

      • setSearchQuery

        @Accessor(qualifier="searchQuery",
          type=SETTER)
public void setSearchQuery​(java.lang.String value,
                           java.util.Locale loc)
        Generated method - Setter of ProductListComponent.searchQuery attribute defined at extension cms2lib.
        Parameters:
        value - the searchQuery
        loc - the value localization key
        Throws:
        java.lang.IllegalArgumentException - if localization key cannot be mapped to data language