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

Class CMSLinkComponentModel

java.lang.Object

de.hybris.platform.servicelayer.model.AbstractItemModel

de.hybris.platform.core.model.ItemModel

de.hybris.platform.cms2.model.contents.CMSItemModel

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

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

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

All Implemented Interfaces:

Serializable

public class CMSLinkComponentModel
extends SimpleCMSComponentModel

Generated model class for type CMSLinkComponent first defined at extension cms2.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class de.hybris.platform.servicelayer.model.AbstractItemModel

de.hybris.platform.servicelayer.model.AbstractItemModel.NewModelContextFactory

Field Summary

Fields

Modifier and Type	Field	Description
static final String	_CMSLINKCOMPONENTSFORCATEGORY	Generated relation code constant for relation CmsLinkComponentsForCategory defining source attribute category in extension cms2.
static final String	_CMSLINKCOMPONENTSFORCONTENTPAGE	Generated relation code constant for relation CmsLinkComponentsForContentPage defining source attribute contentPage in extension cms2.
static final String	_CMSLINKCOMPONENTSFORPRODUCT	Generated relation code constant for relation CmsLinkComponentsForProduct defining source attribute product in extension cms2.
static final String	_TYPECODE	Generated model type code constant.
static final String	CATEGORY	Generated constant - Attribute key of CMSLinkComponent.category attribute defined at extension cms2.
static final String	CATEGORYCODE	Generated constant - Attribute key of CMSLinkComponent.categoryCode attribute defined at extension cms2.
static final String	CATEGORYPOS	Generated constant - Attribute key of CMSLinkComponent.categoryPOS attribute defined at extension cms2.
static final String	CONTENTPAGE	Generated constant - Attribute key of CMSLinkComponent.contentPage attribute defined at extension cms2.
static final String	CONTENTPAGELABELORID	Generated constant - Attribute key of CMSLinkComponent.contentPageLabelOrId attribute defined at extension cms2.
static final String	CONTENTPAGEPOS	Generated constant - Attribute key of CMSLinkComponent.contentPagePOS attribute defined at extension cms2.
static final String	EXTERNAL	Generated constant - Attribute key of CMSLinkComponent.external attribute defined at extension cms2.
static final String	LINKNAME	Generated constant - Attribute key of CMSLinkComponent.linkName attribute defined at extension cms2.
static final String	NAVIGATIONNODES	Generated constant - Attribute key of CMSLinkComponent.navigationNodes attribute defined at extension cms2.
static final String	PRODUCT	Generated constant - Attribute key of CMSLinkComponent.product attribute defined at extension cms2.
static final String	PRODUCTCODE	Generated constant - Attribute key of CMSLinkComponent.productCode attribute defined at extension cms2.
static final String	PRODUCTPOS	Generated constant - Attribute key of CMSLinkComponent.productPOS attribute defined at extension cms2.
static final String	STYLEATTRIBUTES	Generated constant - Attribute key of CMSLinkComponent.styleAttributes attribute defined at extension acceleratorcms.
static final String	TARGET	Generated constant - Attribute key of CMSLinkComponent.target attribute defined at extension cms2.
static final String	URL	Generated constant - Attribute key of CMSLinkComponent.url attribute defined at extension cms2.

Fields inherited from class de.hybris.platform.cms2.model.contents.components.SimpleCMSComponentModel

_ELEMENTSFORCONTAINER, CONTAINERS

Fields inherited from class de.hybris.platform.cms2.model.contents.components.AbstractCMSComponentModel

_CMSCOMPONENTCHILDRENFORCMSCOMPONENT, _ELEMENTSFORSLOT, ACTIONS, CHILDREN, CONTAINER, ONLYONERESTRICTIONMUSTAPPLY, PARENTS, RESTRICTED, RESTRICTIONS, SLOTS, STYLECLASSES, TYPE, TYPECODE, VISIBLE

Fields inherited from class de.hybris.platform.cms2.model.contents.CMSItemModel

CATALOGVERSION, NAME, SYNCHRONIZATIONBLOCKED, UID

Fields inherited from class de.hybris.platform.core.model.ItemModel

_COMMENTITEMRELATION, COMMENTS, CREATIONTIME, ITEMTYPE, MODIFIEDTIME, OWNER, PK, SEALED

Fields inherited from class de.hybris.platform.servicelayer.model.AbstractItemModel

LANGUAGE_FALLBACK_ENABLED_SERVICE_LAYER, MODEL_CONTEXT_FACTORY

Constructor Summary

Constructors

Constructor	Description
CMSLinkComponentModel()	Generated constructor - Default constructor for generic creation.
CMSLinkComponentModel(CatalogVersionModel _catalogVersion, ItemModel _owner, 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
CMSLinkComponentModel(CatalogVersionModel _catalogVersion, 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
CMSLinkComponentModel(de.hybris.platform.servicelayer.model.ItemModelContext ctx)	Generated constructor - Default constructor for creation with existing context

Method Summary

Modifier and Type	Method	Description
CategoryModel	getCategory()	Generated method - Getter of the CMSLinkComponent.category attribute defined at extension cms2.
String	getCategoryCode()	Deprecated, for removal: This API element is subject to removal in a future version. since 4.3
ContentPageModel	getContentPage()	Generated method - Getter of the CMSLinkComponent.contentPage attribute defined at extension cms2.
String	getContentPageLabelOrId()	Deprecated, for removal: This API element is subject to removal in a future version. since 4.3
String	getLinkName()	Generated method - Getter of the CMSLinkComponent.linkName attribute defined at extension cms2.
String	getLinkName(Locale loc)	Generated method - Getter of the CMSLinkComponent.linkName attribute defined at extension cms2.
List<CMSNavigationNodeModel>	getNavigationNodes()	Deprecated, for removal: This API element is subject to removal in a future version. since 4.4
ProductModel	getProduct()	Generated method - Getter of the CMSLinkComponent.product attribute defined at extension cms2.
String	getProductCode()	Deprecated, for removal: This API element is subject to removal in a future version. since 4.3
String	getStyleAttributes()	Generated method - Getter of the CMSLinkComponent.styleAttributes attribute defined at extension acceleratorcms.
LinkTargets	getTarget()	Generated method - Getter of the CMSLinkComponent.target attribute defined at extension cms2.
String	getUrl()	Generated method - Getter of the CMSLinkComponent.url attribute defined at extension cms2.
boolean	isExternal()	Generated method - Getter of the CMSLinkComponent.external attribute defined at extension cms2.
void	setCategory(CategoryModel value)	Generated method - Setter of CMSLinkComponent.category attribute defined at extension cms2.
void	setContentPage(ContentPageModel value)	Generated method - Setter of CMSLinkComponent.contentPage attribute defined at extension cms2.
void	setExternal(boolean value)	Generated method - Setter of CMSLinkComponent.external attribute defined at extension cms2.
void	setLinkName(String value)	Generated method - Setter of CMSLinkComponent.linkName attribute defined at extension cms2.
void	setLinkName(String value, Locale loc)	Generated method - Setter of CMSLinkComponent.linkName attribute defined at extension cms2.
void	setNavigationNodes(List<CMSNavigationNodeModel> value)	Deprecated, for removal: This API element is subject to removal in a future version. since 4.4
void	setProduct(ProductModel value)	Generated method - Setter of CMSLinkComponent.product attribute defined at extension cms2.
void	setStyleAttributes(String value)	Generated method - Setter of CMSLinkComponent.styleAttributes attribute defined at extension acceleratorcms.
void	setTarget(LinkTargets value)	Generated method - Setter of CMSLinkComponent.target attribute defined at extension cms2.
void	setUrl(String value)	Generated method - Setter of CMSLinkComponent.url attribute defined at extension cms2.

Methods inherited from class de.hybris.platform.cms2.model.contents.components.SimpleCMSComponentModel

getContainers, setContainers

Methods inherited from class de.hybris.platform.cms2.model.contents.components.AbstractCMSComponentModel

getActions, getChildren, getParents, getRestrictions, getSlots, getStyleClasses, getType, getType, getTypeCode, getVisible, isContainer, isOnlyOneRestrictionMustApply, isRestricted, setActions, setChildren, setOnlyOneRestrictionMustApply, setParents, setRestrictions, setSlots, setStyleClasses, setVisible

Methods inherited from class de.hybris.platform.cms2.model.contents.CMSItemModel

getCatalogVersion, getName, getUid, isSynchronizationBlocked, setCatalogVersion, setName, setSynchronizationBlocked, setUid

Methods inherited from class de.hybris.platform.core.model.ItemModel

getComments, getCreationtime, getModifiedtime, getOwner, isSealed, setComments, setCreationtime, setModifiedtime, setOwner

Methods inherited from class de.hybris.platform.servicelayer.model.AbstractItemModel

equals, getItemModelContext, getItemtype, getPersistenceContext, getPk, getProperty, getProperty, getTenantId, hashCode, readResolve, setProperty, setProperty, toObject, toObject, toObject, toObject, toObject, toObject, toObject, toObject, toPrimitive, toPrimitive, toPrimitive, toPrimitive, toPrimitive, toPrimitive, toPrimitive, toPrimitive, toString, writeReplace

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

_TYPECODE

public static final String _TYPECODE

Generated model type code constant.

See Also:

• Constant Field Values

_CMSLINKCOMPONENTSFORCONTENTPAGE

public static final 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 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 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 String LINKNAME

Generated constant - Attribute key of CMSLinkComponent.linkName attribute defined at extension cms2.

See Also:

• Constant Field Values

EXTERNAL

public static final String EXTERNAL

Generated constant - Attribute key of CMSLinkComponent.external attribute defined at extension cms2.

See Also:

• Constant Field Values

URL

public static final String URL

Generated constant - Attribute key of CMSLinkComponent.url attribute defined at extension cms2.

See Also:

• Constant Field Values

CONTENTPAGELABELORID

public static final String CONTENTPAGELABELORID

Generated constant - Attribute key of CMSLinkComponent.contentPageLabelOrId attribute defined at extension cms2.

See Also:

• Constant Field Values

PRODUCTCODE

public static final String PRODUCTCODE

Generated constant - Attribute key of CMSLinkComponent.productCode attribute defined at extension cms2.

See Also:

• Constant Field Values

CATEGORYCODE

public static final String CATEGORYCODE

Generated constant - Attribute key of CMSLinkComponent.categoryCode attribute defined at extension cms2.

See Also:

• Constant Field Values

TARGET

public static final String TARGET

Generated constant - Attribute key of CMSLinkComponent.target attribute defined at extension cms2.

See Also:

• Constant Field Values

NAVIGATIONNODES

public static final String NAVIGATIONNODES

Generated constant - Attribute key of CMSLinkComponent.navigationNodes attribute defined at extension cms2.

See Also:

• Constant Field Values

CONTENTPAGEPOS

public static final String CONTENTPAGEPOS

Generated constant - Attribute key of CMSLinkComponent.contentPagePOS attribute defined at extension cms2.

See Also:

• Constant Field Values

CONTENTPAGE

public static final String CONTENTPAGE

Generated constant - Attribute key of CMSLinkComponent.contentPage attribute defined at extension cms2.

See Also:

• Constant Field Values

PRODUCTPOS

public static final String PRODUCTPOS

Generated constant - Attribute key of CMSLinkComponent.productPOS attribute defined at extension cms2.

See Also:

• Constant Field Values

PRODUCT

public static final String PRODUCT

Generated constant - Attribute key of CMSLinkComponent.product attribute defined at extension cms2.

See Also:

• Constant Field Values

CATEGORYPOS

public static final String CATEGORYPOS

Generated constant - Attribute key of CMSLinkComponent.categoryPOS attribute defined at extension cms2.

See Also:

• Constant Field Values

CATEGORY

public static final String CATEGORY

Generated constant - Attribute key of CMSLinkComponent.category attribute defined at extension cms2.

See Also:

• Constant Field Values

STYLEATTRIBUTES

public static final String STYLEATTRIBUTES

Generated constant - Attribute key of CMSLinkComponent.styleAttributes attribute defined at extension acceleratorcms.

See Also:

• Constant Field Values

Constructor Details

CMSLinkComponentModel

public CMSLinkComponentModel()

Generated constructor - Default constructor for generic creation.

CMSLinkComponentModel

public CMSLinkComponentModel(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

CMSLinkComponentModel

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

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 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 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 String getLinkName()

Generated method - Getter of the CMSLinkComponent.linkName attribute defined at extension cms2.

Returns:

the linkName

getLinkName

@Accessor(qualifier="linkName",
          type=GETTER)
public String getLinkName(Locale loc)

Generated method - Getter of the CMSLinkComponent.linkName attribute defined at extension cms2.

Parameters:

loc - the value localization key

Returns:

the linkName

Throws:

IllegalArgumentException - if localization key cannot be mapped to data language

getNavigationNodes

@Deprecated(since="4.4",
            forRemoval=true)
@Accessor(qualifier="navigationNodes",
          type=GETTER)
public 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 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 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

getUrl

@Accessor(qualifier="url",
          type=GETTER)
public 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

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(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(String value,
 Locale loc)

Generated method - Setter of CMSLinkComponent.linkName attribute defined at extension cms2.

Parameters:

value - the linkName

loc - the value localization key

Throws:

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(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(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

setUrl

@Accessor(qualifier="url",
          type=SETTER)
public void setUrl(String value)

Generated method - Setter of CMSLinkComponent.url attribute defined at extension cms2.

Parameters:

value - the url