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

Class MiniCartComponentModel

  • All Implemented Interfaces:
    java.io.Serializable
    public class MiniCartComponentModel
extends SimpleCMSComponentModel
    Generated model class for type MiniCartComponent first defined at extension acceleratorcms.

    It represents mini cart component that can be configured to show some information about cart content.

    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 MiniCartComponent.title attribute defined at extension acceleratorcms.
        See Also:
        Constant Field Values

      • TOTALDISPLAY

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

      • SHOWNPRODUCTCOUNT

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

      • LIGHTBOXBANNERCOMPONENT

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

    • Constructor Detail

      • MiniCartComponentModel

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

      • MiniCartComponentModel

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

      • MiniCartComponentModel

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

      • MiniCartComponentModel

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

      • getLightboxBannerComponent

        @Accessor(qualifier="lightboxBannerComponent",
          type=GETTER)
public SimpleBannerComponentModel getLightboxBannerComponent()
        Generated method - Getter of the MiniCartComponent.lightboxBannerComponent attribute defined at extension acceleratorcms.
        Returns:
        the lightboxBannerComponent - It is a banner component that can be displayed in the mini cart.

      • getShownProductCount

        @Accessor(qualifier="shownProductCount",
          type=GETTER)
public int getShownProductCount()
        Generated method - Getter of the MiniCartComponent.shownProductCount attribute defined at extension acceleratorcms.
        Returns:
        the shownProductCount - It controls the maximum number of products to display in the component.

      • getTitle

        @Accessor(qualifier="title",
          type=GETTER)
public java.lang.String getTitle()
        Generated method - Getter of the MiniCartComponent.title attribute defined at extension acceleratorcms.
        Returns:
        the title - It is 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 MiniCartComponent.title attribute defined at extension acceleratorcms.
        Parameters:
        loc - the value localization key
        Returns:
        the title - It is localized title of the component.
        Throws:
        java.lang.IllegalArgumentException - if localization key cannot be mapped to data language

      • getTotalDisplay

        @Accessor(qualifier="totalDisplay",
          type=GETTER)
public CartTotalDisplayType getTotalDisplay()
        Generated method - Getter of the MiniCartComponent.totalDisplay attribute defined at extension acceleratorcms.
        Returns:
        the totalDisplay - This attribute determines the type of displayed total cart value.

      • setLightboxBannerComponent

        @Accessor(qualifier="lightboxBannerComponent",
          type=SETTER)
public void setLightboxBannerComponent​(SimpleBannerComponentModel value)
        Generated method - Setter of MiniCartComponent.lightboxBannerComponent attribute defined at extension acceleratorcms.
        Parameters:
        value - the lightboxBannerComponent - It is a banner component that can be displayed in the mini cart.

      • setShownProductCount

        @Accessor(qualifier="shownProductCount",
          type=SETTER)
public void setShownProductCount​(int value)
        Generated method - Setter of MiniCartComponent.shownProductCount attribute defined at extension acceleratorcms.
        Parameters:
        value - the shownProductCount - It controls the maximum number of products to display in the component.

      • setTitle

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

      • setTotalDisplay

        @Accessor(qualifier="totalDisplay",
          type=SETTER)
public void setTotalDisplay​(CartTotalDisplayType value)
        Generated method - Setter of MiniCartComponent.totalDisplay attribute defined at extension acceleratorcms.
        Parameters:
        value - the totalDisplay - This attribute determines the type of displayed total cart value.