Class ProductListComponentModel

All Implemented Interfaces:
Serializable

public class ProductListComponentModel extends SimpleCMSComponentModel
Generated model class for type ProductListComponent first defined at extension cms2lib.
See Also:
  • Field Details

    • _TYPECODE

      public static final String _TYPECODE
      Generated model type code constant.
      See Also:
    • HEADLINE

      public static final String HEADLINE
      Generated constant - Attribute key of ProductListComponent.headline attribute defined at extension cms2lib.
      See Also:
    • CATEGORYCODE

      public static final String CATEGORYCODE
      Generated constant - Attribute key of ProductListComponent.categoryCode attribute defined at extension cms2lib.
      See Also:
    • PRODUCTSFROMCONTEXT

      public static final String PRODUCTSFROMCONTEXT
      Generated constant - Attribute key of ProductListComponent.productsFromContext attribute defined at extension cms2lib.
      See Also:
    • SEARCHQUERY

      public static final String SEARCHQUERY
      Generated constant - Attribute key of ProductListComponent.searchQuery attribute defined at extension cms2lib.
      See Also:
    • PAGINATION

      public static final String PAGINATION
      Generated constant - Attribute key of ProductListComponent.pagination attribute defined at extension cms2lib.
      See Also:
    • LAYOUT

      public static final String LAYOUT
      Generated constant - Attribute key of ProductListComponent.layout attribute defined at extension cms2lib.
      See Also:
    • PRODUCTCODES

      public static final String PRODUCTCODES
      Generated constant - Attribute key of ProductListComponent.productCodes attribute defined at extension cms2lib.
      See Also:
    • PRODUCTS

      public static final String PRODUCTS
      Generated constant - Attribute key of ProductListComponent.products attribute defined at extension cms2lib.
      See Also:
    • CATEGORY

      public static final String CATEGORY
      Generated constant - Attribute key of ProductListComponent.category attribute defined at extension cms2lib.
      See Also:
  • Constructor Details

    • ProductListComponentModel

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

      public ProductListComponentModel(de.hybris.platform.servicelayer.model.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, 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, 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 Details

    • 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 String getCategoryCode()
      Generated method - Getter of the ProductListComponent.categoryCode attribute defined at extension cms2lib.
      Returns:
      the categoryCode
    • getHeadline

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

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

      @Accessor(qualifier="layout", type=GETTER) public ProductListLayouts getLayout()
      Generated method - Getter of the ProductListComponent.layout attribute defined at extension cms2lib.
      Returns:
      the layout
    • getProductCodes

      @Accessor(qualifier="productCodes", type=GETTER) public List<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 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 String getSearchQuery()
      Generated method - Getter of the ProductListComponent.searchQuery attribute defined at extension cms2lib.
      Returns:
      the searchQuery
    • getSearchQuery

      @Accessor(qualifier="searchQuery", type=GETTER) public String getSearchQuery(Locale loc)
      Generated method - Getter of the ProductListComponent.searchQuery attribute defined at extension cms2lib.
      Parameters:
      loc - the value localization key
      Returns:
      the searchQuery
      Throws:
      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(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(String value, Locale loc)
      Generated method - Setter of ProductListComponent.headline attribute defined at extension cms2lib.
      Parameters:
      value - the headline
      loc - the value localization key
      Throws:
      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(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(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(String value, Locale loc)
      Generated method - Setter of ProductListComponent.searchQuery attribute defined at extension cms2lib.
      Parameters:
      value - the searchQuery
      loc - the value localization key
      Throws:
      IllegalArgumentException - if localization key cannot be mapped to data language