Package de.hybris.platform.acceleratorcms.model.components

Class ProductReferencesComponentModel

  • All Implemented Interfaces:
    java.io.Serializable
    Direct Known Subclasses:
    SimpleSuggestionComponentModel
    public class ProductReferencesComponentModel
extends SimpleCMSComponentModel
    Generated model class for type ProductReferencesComponent first defined at extension acceleratorcms.

    It represents product references component, that is the component that displays configured references to the specified product.

    See Also:
    Serialized Form

    • Field Detail

      • _TYPECODE

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

      • TITLE

        public static final java.lang.String TITLE
        Generated constant - Attribute key of ProductReferencesComponent.title attribute defined at extension acceleratorcms.
        See Also:
        Constant Field Values

      • PRODUCTREFERENCETYPES

        public static final java.lang.String PRODUCTREFERENCETYPES
        Generated constant - Attribute key of ProductReferencesComponent.productReferenceTypes attribute defined at extension acceleratorcms.
        See Also:
        Constant Field Values

      • MAXIMUMNUMBERPRODUCTS

        public static final java.lang.String MAXIMUMNUMBERPRODUCTS
        Generated constant - Attribute key of ProductReferencesComponent.maximumNumberProducts attribute defined at extension acceleratorcms.
        See Also:
        Constant Field Values

      • DISPLAYPRODUCTTITLES

        public static final java.lang.String DISPLAYPRODUCTTITLES
        Generated constant - Attribute key of ProductReferencesComponent.displayProductTitles attribute defined at extension acceleratorcms.
        See Also:
        Constant Field Values

      • DISPLAYPRODUCTPRICES

        public static final java.lang.String DISPLAYPRODUCTPRICES
        Generated constant - Attribute key of ProductReferencesComponent.displayProductPrices attribute defined at extension acceleratorcms.
        See Also:
        Constant Field Values

    • Constructor Detail

      • ProductReferencesComponentModel

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

      • ProductReferencesComponentModel

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

      • ProductReferencesComponentModel

        @Deprecated(since="4.1.1",
            forRemoval=true)
public ProductReferencesComponentModel​(CatalogVersionModel _catalogVersion,
                                       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
        _uid - initial attribute declared by type CMSItem at extension cms2

      • ProductReferencesComponentModel

        @Deprecated(since="4.1.1",
            forRemoval=true)
public ProductReferencesComponentModel​(CatalogVersionModel _catalogVersion,
                                       ItemModel _owner,
                                       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
        _uid - initial attribute declared by type CMSItem at extension cms2

    • Method Detail

      • getMaximumNumberProducts

        @Accessor(qualifier="maximumNumberProducts",
          type=GETTER)
public java.lang.Integer getMaximumNumberProducts()
        Generated method - Getter of the ProductReferencesComponent.maximumNumberProducts attribute defined at extension acceleratorcms.
        Returns:
        the maximumNumberProducts - Maximum number of the product references that are displayed in the component.

      • getProductReferenceTypes

        @Accessor(qualifier="productReferenceTypes",
          type=GETTER)
public java.util.List<ProductReferenceTypeEnum> getProductReferenceTypes()
        Generated method - Getter of the ProductReferencesComponent.productReferenceTypes attribute defined at extension acceleratorcms. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
        Returns:
        the productReferenceTypes - Product reference type that is displayed in this component.

      • getTitle

        @Accessor(qualifier="title",
          type=GETTER)
public java.lang.String getTitle()
        Generated method - Getter of the ProductReferencesComponent.title attribute defined at extension acceleratorcms.
        Returns:
        the title - Title of the component.

      • getTitle

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

      • isDisplayProductPrices

        @Accessor(qualifier="displayProductPrices",
          type=GETTER)
public boolean isDisplayProductPrices()
        Generated method - Getter of the ProductReferencesComponent.displayProductPrices attribute defined at extension acceleratorcms.
        Returns:
        the displayProductPrices - Determines if product prices are shown.

      • isDisplayProductTitles

        @Accessor(qualifier="displayProductTitles",
          type=GETTER)
public boolean isDisplayProductTitles()
        Generated method - Getter of the ProductReferencesComponent.displayProductTitles attribute defined at extension acceleratorcms.
        Returns:
        the displayProductTitles - Determines if product titles are shown.

      • setDisplayProductPrices

        @Accessor(qualifier="displayProductPrices",
          type=SETTER)
public void setDisplayProductPrices​(boolean value)
        Generated method - Setter of ProductReferencesComponent.displayProductPrices attribute defined at extension acceleratorcms.
        Parameters:
        value - the displayProductPrices - Determines if product prices are shown.

      • setDisplayProductTitles

        @Accessor(qualifier="displayProductTitles",
          type=SETTER)
public void setDisplayProductTitles​(boolean value)
        Generated method - Setter of ProductReferencesComponent.displayProductTitles attribute defined at extension acceleratorcms.
        Parameters:
        value - the displayProductTitles - Determines if product titles are shown.

      • setMaximumNumberProducts

        @Accessor(qualifier="maximumNumberProducts",
          type=SETTER)
public void setMaximumNumberProducts​(java.lang.Integer value)
        Generated method - Setter of ProductReferencesComponent.maximumNumberProducts attribute defined at extension acceleratorcms.
        Parameters:
        value - the maximumNumberProducts - Maximum number of the product references that are displayed in the component.

      • setProductReferenceTypes

        @Accessor(qualifier="productReferenceTypes",
          type=SETTER)
public void setProductReferenceTypes​(java.util.List<ProductReferenceTypeEnum> value)
        Generated method - Setter of ProductReferencesComponent.productReferenceTypes attribute defined at extension acceleratorcms.
        Parameters:
        value - the productReferenceTypes - Product reference type that is displayed in this component.

      • setTitle

        @Accessor(qualifier="title",
          type=SETTER)
public void setTitle​(java.lang.String value)
        Generated method - Setter of ProductReferencesComponent.title attribute defined at extension acceleratorcms.
        Parameters:
        value - the title - Title of the component.

      • setTitle

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