Package de.hybris.platform.cms2.model.contents.components

Class CMSLinkComponentModel

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

    • Field Detail

      • _TYPECODE

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

      • _CMSLINKCOMPONENTSFORCONTENTPAGE

        public static final java.lang.String _CMSLINKCOMPONENTSFORCONTENTPAGE
        Generated relation code constant for relation CmsLinkComponentsForContentPage defining source attribute contentPage in extension cms2.
        See Also:
        Constant Field Values

      • _CMSLINKCOMPONENTSFORPRODUCT

        public static final java.lang.String _CMSLINKCOMPONENTSFORPRODUCT
        Generated relation code constant for relation CmsLinkComponentsForProduct defining source attribute product in extension cms2.
        See Also:
        Constant Field Values

      • _CMSLINKCOMPONENTSFORCATEGORY

        public static final java.lang.String _CMSLINKCOMPONENTSFORCATEGORY
        Generated relation code constant for relation CmsLinkComponentsForCategory defining source attribute category in extension cms2.
        See Also:
        Constant Field Values

      • LINKNAME

        public static final java.lang.String LINKNAME
        Generated constant - Attribute key of CMSLinkComponent.linkName attribute defined at extension cms2.
        See Also:
        Constant Field Values

      • EXTERNAL

        public static final java.lang.String EXTERNAL
        Generated constant - Attribute key of CMSLinkComponent.external attribute defined at extension cms2.
        See Also:
        Constant Field Values

      • URL

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

      • CONTENTPAGELABELORID

        public static final java.lang.String CONTENTPAGELABELORID
        Generated constant - Attribute key of CMSLinkComponent.contentPageLabelOrId attribute defined at extension cms2.
        See Also:
        Constant Field Values

      • PRODUCTCODE

        public static final java.lang.String PRODUCTCODE
        Generated constant - Attribute key of CMSLinkComponent.productCode attribute defined at extension cms2.
        See Also:
        Constant Field Values

      • CATEGORYCODE

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

      • TARGET

        public static final java.lang.String TARGET
        Generated constant - Attribute key of CMSLinkComponent.target attribute defined at extension cms2.
        See Also:
        Constant Field Values

      • NAVIGATIONNODES

        public static final java.lang.String NAVIGATIONNODES
        Generated constant - Attribute key of CMSLinkComponent.navigationNodes attribute defined at extension cms2.
        See Also:
        Constant Field Values

      • CONTENTPAGEPOS

        public static final java.lang.String CONTENTPAGEPOS
        Generated constant - Attribute key of CMSLinkComponent.contentPagePOS attribute defined at extension cms2.
        See Also:
        Constant Field Values

      • CONTENTPAGE

        public static final java.lang.String CONTENTPAGE
        Generated constant - Attribute key of CMSLinkComponent.contentPage attribute defined at extension cms2.
        See Also:
        Constant Field Values

      • PRODUCTPOS

        public static final java.lang.String PRODUCTPOS
        Generated constant - Attribute key of CMSLinkComponent.productPOS attribute defined at extension cms2.
        See Also:
        Constant Field Values

      • PRODUCT

        public static final java.lang.String PRODUCT
        Generated constant - Attribute key of CMSLinkComponent.product attribute defined at extension cms2.
        See Also:
        Constant Field Values

      • CATEGORYPOS

        public static final java.lang.String CATEGORYPOS
        Generated constant - Attribute key of CMSLinkComponent.categoryPOS attribute defined at extension cms2.
        See Also:
        Constant Field Values

      • CATEGORY

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

      • STYLEATTRIBUTES

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

      • THUMBNAIL

        public static final java.lang.String THUMBNAIL
        Generated constant - Attribute key of CMSLinkComponent.thumbnail attribute defined at extension verticalnavigationaddon.
        See Also:
        Constant Field Values

      • THUMBNAILONLY

        public static final java.lang.String THUMBNAILONLY
        Generated constant - Attribute key of CMSLinkComponent.thumbnailOnly attribute defined at extension verticalnavigationaddon.
        See Also:
        Constant Field Values

    • Constructor Detail

      • CMSLinkComponentModel

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

      • CMSLinkComponentModel

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

      • CMSLinkComponentModel

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

      • CMSLinkComponentModel

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

      • getCategory

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

      • getCategoryCode

        @Deprecated(since="4.3",
            forRemoval=true)
@Accessor(qualifier="categoryCode",
          type=GETTER)
public java.lang.String getCategoryCode()
        Deprecated, for removal: This API element is subject to removal in a future version.
        since 4.3
        Generated method - Getter of the CMSLinkComponent.categoryCode attribute defined at extension cms2.
        Returns:
        the categoryCode

      • getContentPage

        @Accessor(qualifier="contentPage",
          type=GETTER)
public ContentPageModel getContentPage()
        Generated method - Getter of the CMSLinkComponent.contentPage attribute defined at extension cms2.
        Returns:
        the contentPage

      • getContentPageLabelOrId

        @Deprecated(since="4.3",
            forRemoval=true)
@Accessor(qualifier="contentPageLabelOrId",
          type=GETTER)
public java.lang.String getContentPageLabelOrId()
        Deprecated, for removal: This API element is subject to removal in a future version.
        since 4.3
        Generated method - Getter of the CMSLinkComponent.contentPageLabelOrId attribute defined at extension cms2.
        Returns:
        the contentPageLabelOrId

      • getLinkName

        @Accessor(qualifier="linkName",
          type=GETTER)
public java.lang.String getLinkName()
        Generated method - Getter of the CMSLinkComponent.linkName attribute defined at extension cms2.
        Returns:
        the linkName

      • getLinkName

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

      • getNavigationNodes

        @Deprecated(since="4.4",
            forRemoval=true)
@Accessor(qualifier="navigationNodes",
          type=GETTER)
public java.util.List<CMSNavigationNodeModel> getNavigationNodes()
        Deprecated, for removal: This API element is subject to removal in a future version.
        since 4.4
        Generated method - Getter of the CMSLinkComponent.navigationNodes attribute defined at extension cms2. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
        Returns:
        the navigationNodes

      • getProduct

        @Accessor(qualifier="product",
          type=GETTER)
public ProductModel getProduct()
        Generated method - Getter of the CMSLinkComponent.product attribute defined at extension cms2.
        Returns:
        the product

      • getProductCode

        @Deprecated(since="4.3",
            forRemoval=true)
@Accessor(qualifier="productCode",
          type=GETTER)
public java.lang.String getProductCode()
        Deprecated, for removal: This API element is subject to removal in a future version.
        since 4.3
        Generated method - Getter of the CMSLinkComponent.productCode attribute defined at extension cms2.
        Returns:
        the productCode

      • getStyleAttributes

        @Accessor(qualifier="styleAttributes",
          type=GETTER)
public java.lang.String getStyleAttributes()
        Generated method - Getter of the CMSLinkComponent.styleAttributes attribute defined at extension acceleratorcms.
        Returns:
        the styleAttributes - Can store custom styling attributes for additional styling

      • getTarget

        @Accessor(qualifier="target",
          type=GETTER)
public LinkTargets getTarget()
        Generated method - Getter of the CMSLinkComponent.target attribute defined at extension cms2.
        Returns:
        the target

      • getThumbnail

        @Accessor(qualifier="thumbnail",
          type=GETTER)
public MediaModel getThumbnail()
        Generated method - Getter of the CMSLinkComponent.thumbnail attribute defined at extension verticalnavigationaddon.
        Returns:
        the thumbnail - image of the Component

      • getUrl

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

      • isExternal

        @Accessor(qualifier="external",
          type=GETTER)
public boolean isExternal()
        Generated method - Getter of the CMSLinkComponent.external attribute defined at extension cms2.
        Returns:
        the external

      • isThumbnailOnly

        @Accessor(qualifier="thumbnailOnly",
          type=GETTER)
public boolean isThumbnailOnly()
        Generated method - Getter of the CMSLinkComponent.thumbnailOnly attribute defined at extension verticalnavigationaddon.
        Returns:
        the thumbnailOnly - Display only the thumbnail without text content for the Link component

      • setCategory

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

      • setContentPage

        @Accessor(qualifier="contentPage",
          type=SETTER)
public void setContentPage​(ContentPageModel value)
        Generated method - Setter of CMSLinkComponent.contentPage attribute defined at extension cms2.
        Parameters:
        value - the contentPage

      • setExternal

        @Accessor(qualifier="external",
          type=SETTER)
public void setExternal​(boolean value)
        Generated method - Setter of CMSLinkComponent.external attribute defined at extension cms2.
        Parameters:
        value - the external

      • setLinkName

        @Accessor(qualifier="linkName",
          type=SETTER)
public void setLinkName​(java.lang.String value)
        Generated method - Setter of CMSLinkComponent.linkName attribute defined at extension cms2.
        Parameters:
        value - the linkName

      • setLinkName

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

      • setNavigationNodes

        @Deprecated(since="4.4",
            forRemoval=true)
@Accessor(qualifier="navigationNodes",
          type=SETTER)
public void setNavigationNodes​(java.util.List<CMSNavigationNodeModel> value)
        Deprecated, for removal: This API element is subject to removal in a future version.
        since 4.4
        Generated method - Setter of CMSLinkComponent.navigationNodes attribute defined at extension cms2.
        Parameters:
        value - the navigationNodes

      • setProduct

        @Accessor(qualifier="product",
          type=SETTER)
public void setProduct​(ProductModel value)
        Generated method - Setter of CMSLinkComponent.product attribute defined at extension cms2.
        Parameters:
        value - the product

      • setStyleAttributes

        @Accessor(qualifier="styleAttributes",
          type=SETTER)
public void setStyleAttributes​(java.lang.String value)
        Generated method - Setter of CMSLinkComponent.styleAttributes attribute defined at extension acceleratorcms.
        Parameters:
        value - the styleAttributes - Can store custom styling attributes for additional styling

      • setTarget

        @Accessor(qualifier="target",
          type=SETTER)
public void setTarget​(LinkTargets value)
        Generated method - Setter of CMSLinkComponent.target attribute defined at extension cms2.
        Parameters:
        value - the target

      • setThumbnail

        @Accessor(qualifier="thumbnail",
          type=SETTER)
public void setThumbnail​(MediaModel value)
        Generated method - Setter of CMSLinkComponent.thumbnail attribute defined at extension verticalnavigationaddon.
        Parameters:
        value - the thumbnail - image of the Component

      • setThumbnailOnly

        @Accessor(qualifier="thumbnailOnly",
          type=SETTER)
public void setThumbnailOnly​(boolean value)
        Generated method - Setter of CMSLinkComponent.thumbnailOnly attribute defined at extension verticalnavigationaddon.
        Parameters:
        value - the thumbnailOnly - Display only the thumbnail without text content for the Link component

      • setUrl

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