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

Class ProductCarouselComponentModel

    • Field Detail

      • _TYPECODE

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

      • SCROLL

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

      • PRODUCTCODES

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

      • CATEGORYCODES

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

      • PRODUCTS

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

      • CATEGORIES

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

      • TITLE

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

      • SEARCHQUERY

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

      • CATEGORYCODE

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

      • POPUP

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

      • MEDIA

        public static final java.lang.String MEDIA
        Generated constant - Attribute key of ProductCarouselComponent.media attribute defined at extension marketplaceservices.
        See Also:
        Constant Field Values

      • URL

        public static final java.lang.String URL
        Generated constant - Attribute key of ProductCarouselComponent.url attribute defined at extension marketplaceservices.
        See Also:
        Constant Field Values

      • VENDORCAROUSELCODE

        public static final java.lang.String VENDORCAROUSELCODE
        Generated constant - Attribute key of ProductCarouselComponent.vendorCarouselCode attribute defined at extension marketplaceservices.
        See Also:
        Constant Field Values

    • Constructor Detail

      • ProductCarouselComponentModel

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

      • ProductCarouselComponentModel

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

      • ProductCarouselComponentModel

        @Deprecated(since="4.1.1",
            forRemoval=true)
public ProductCarouselComponentModel​(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

      • ProductCarouselComponentModel

        @Deprecated(since="4.1.1",
            forRemoval=true)
public ProductCarouselComponentModel​(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

      • getCategories

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

      • getCategoryCode

        @Accessor(qualifier="categoryCode",
          type=GETTER)
public java.lang.String getCategoryCode()
        Generated method - Getter of the ProductCarouselComponent.categoryCode attribute defined at extension acceleratorcms.
        Returns:
        the categoryCode - A code for a category for a solr search

      • getCategoryCodes

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

      • getMedia

        @Accessor(qualifier="media",
          type=GETTER)
public MediaModel getMedia()
        Generated method - Getter of the ProductCarouselComponent.media attribute defined at extension marketplaceservices.
        Returns:
        the media - Localized media that is displayed in the component.

      • getMedia

        @Accessor(qualifier="media",
          type=GETTER)
public MediaModel getMedia​(java.util.Locale loc)
        Generated method - Getter of the ProductCarouselComponent.media attribute defined at extension marketplaceservices.
        Parameters:
        loc - the value localization key
        Returns:
        the media - Localized media that is displayed in the component.
        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 ProductCarouselComponent.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 ProductCarouselComponent.products attribute defined at extension cms2lib. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
        Returns:
        the products

      • getScroll

        @Accessor(qualifier="scroll",
          type=GETTER)
public CarouselScroll getScroll()
        Generated method - Getter of the ProductCarouselComponent.scroll attribute defined at extension cms2lib.
        Returns:
        the scroll

      • getSearchQuery

        @Accessor(qualifier="searchQuery",
          type=GETTER)
public java.lang.String getSearchQuery()
        Generated method - Getter of the ProductCarouselComponent.searchQuery attribute defined at extension acceleratorcms.
        Returns:
        the searchQuery - A solr query string

      • getTitle

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

      • getTitle

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

      • getUrl

        @Accessor(qualifier="url",
          type=GETTER)
public java.lang.String getUrl()
        Generated method - Getter of the ProductCarouselComponent.url attribute defined at extension marketplaceservices.
        Returns:
        the url

      • getVendorCarouselCode

        @Accessor(qualifier="vendorCarouselCode",
          type=GETTER)
public java.lang.String getVendorCarouselCode()
        Generated method - Getter of the ProductCarouselComponent.vendorCarouselCode attribute defined at extension marketplaceservices.
        Returns:
        the vendorCarouselCode

      • isPopup

        @Accessor(qualifier="popup",
          type=GETTER)
public boolean isPopup()
        Generated method - Getter of the ProductCarouselComponent.popup attribute defined at extension acceleratorcms.
        Returns:
        the popup - If true shows a popup else redirects to products page

      • setCategories

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

      • setCategoryCode

        @Accessor(qualifier="categoryCode",
          type=SETTER)
public void setCategoryCode​(java.lang.String value)
        Generated method - Setter of ProductCarouselComponent.categoryCode attribute defined at extension acceleratorcms.
        Parameters:
        value - the categoryCode - A code for a category for a solr search

      • setMedia

        @Accessor(qualifier="media",
          type=SETTER)
public void setMedia​(MediaModel value)
        Generated method - Setter of ProductCarouselComponent.media attribute defined at extension marketplaceservices.
        Parameters:
        value - the media - Localized media that is displayed in the component.

      • setMedia

        @Accessor(qualifier="media",
          type=SETTER)
public void setMedia​(MediaModel value,
                     java.util.Locale loc)
        Generated method - Setter of ProductCarouselComponent.media attribute defined at extension marketplaceservices.
        Parameters:
        value - the media - Localized media that is displayed in the component.
        loc - the value localization key
        Throws:
        java.lang.IllegalArgumentException - if localization key cannot be mapped to data language

      • setPopup

        @Accessor(qualifier="popup",
          type=SETTER)
public void setPopup​(boolean value)
        Generated method - Setter of ProductCarouselComponent.popup attribute defined at extension acceleratorcms.
        Parameters:
        value - the popup - If true shows a popup else redirects to products page

      • setProducts

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

      • setScroll

        @Accessor(qualifier="scroll",
          type=SETTER)
public void setScroll​(CarouselScroll value)
        Generated method - Setter of ProductCarouselComponent.scroll attribute defined at extension cms2lib.
        Parameters:
        value - the scroll

      • setSearchQuery

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

      • setTitle

        @Accessor(qualifier="title",
          type=SETTER)
public void setTitle​(java.lang.String value)
        Generated method - Setter of ProductCarouselComponent.title attribute defined at extension acceleratorcms.
        Parameters:
        value - the title - Localized 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 ProductCarouselComponent.title attribute defined at extension acceleratorcms.
        Parameters:
        value - the title - Localized title of the component.
        loc - the value localization key
        Throws:
        java.lang.IllegalArgumentException - if localization key cannot be mapped to data language

      • setUrl

        @Accessor(qualifier="url",
          type=SETTER)
public void setUrl​(java.lang.String value)
        Generated method - Setter of ProductCarouselComponent.url attribute defined at extension marketplaceservices.
        Parameters:
        value - the url

      • setVendorCarouselCode

        @Accessor(qualifier="vendorCarouselCode",
          type=SETTER)
public void setVendorCarouselCode​(java.lang.String value)
        Generated method - Setter of ProductCarouselComponent.vendorCarouselCode attribute defined at extension marketplaceservices.
        Parameters:
        value - the vendorCarouselCode