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

Class ProductReferencesComponentModel

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.acceleratorcms.model.components.ProductReferencesComponentModel

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ProductReferencesAndClassificationsComponentModel, ServiceUsageUpSellComponentModel, SimpleSuggestionComponentModel, SubscriptionCrossSellComponentModel

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

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	_TYPECODE	Generated model type code constant.
static final String	DISPLAYPRODUCTPRICES	Generated constant - Attribute key of ProductReferencesComponent.displayProductPrices attribute defined at extension acceleratorcms.
static final String	DISPLAYPRODUCTTITLES	Generated constant - Attribute key of ProductReferencesComponent.displayProductTitles attribute defined at extension acceleratorcms.
static final String	MAXIMUMNUMBERPRODUCTS	Generated constant - Attribute key of ProductReferencesComponent.maximumNumberProducts attribute defined at extension acceleratorcms.
static final String	PRODUCTREFERENCETYPES	Generated constant - Attribute key of ProductReferencesComponent.productReferenceTypes attribute defined at extension acceleratorcms.
static final String	TITLE	Generated constant - Attribute key of ProductReferencesComponent.title attribute defined at extension acceleratorcms.

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
ProductReferencesComponentModel()	Generated constructor - Default constructor for generic creation.
ProductReferencesComponentModel(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
ProductReferencesComponentModel(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
ProductReferencesComponentModel(de.hybris.platform.servicelayer.model.ItemModelContext ctx)	Generated constructor - Default constructor for creation with existing context

Method Summary

Modifier and Type	Method	Description
Integer	getMaximumNumberProducts()	Generated method - Getter of the ProductReferencesComponent.maximumNumberProducts attribute defined at extension acceleratorcms.
List<ProductReferenceTypeEnum>	getProductReferenceTypes()	Generated method - Getter of the ProductReferencesComponent.productReferenceTypes attribute defined at extension acceleratorcms.
String	getTitle()	Generated method - Getter of the ProductReferencesComponent.title attribute defined at extension acceleratorcms.
String	getTitle(Locale loc)	Generated method - Getter of the ProductReferencesComponent.title attribute defined at extension acceleratorcms.
boolean	isDisplayProductPrices()	Generated method - Getter of the ProductReferencesComponent.displayProductPrices attribute defined at extension acceleratorcms.
boolean	isDisplayProductTitles()	Generated method - Getter of the ProductReferencesComponent.displayProductTitles attribute defined at extension acceleratorcms.
void	setDisplayProductPrices(boolean value)	Generated method - Setter of ProductReferencesComponent.displayProductPrices attribute defined at extension acceleratorcms.
void	setDisplayProductTitles(boolean value)	Generated method - Setter of ProductReferencesComponent.displayProductTitles attribute defined at extension acceleratorcms.
void	setMaximumNumberProducts(Integer value)	Generated method - Setter of ProductReferencesComponent.maximumNumberProducts attribute defined at extension acceleratorcms.
void	setProductReferenceTypes(List<ProductReferenceTypeEnum> value)	Generated method - Setter of ProductReferencesComponent.productReferenceTypes attribute defined at extension acceleratorcms.
void	setTitle(String value)	Generated method - Setter of ProductReferencesComponent.title attribute defined at extension acceleratorcms.
void	setTitle(String value, Locale loc)	Generated method - Setter of ProductReferencesComponent.title attribute defined at extension acceleratorcms.

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

TITLE

public static final String TITLE

Generated constant - Attribute key of ProductReferencesComponent.title attribute defined at extension acceleratorcms.

See Also:

• Constant Field Values

PRODUCTREFERENCETYPES

public static final String PRODUCTREFERENCETYPES

Generated constant - Attribute key of ProductReferencesComponent.productReferenceTypes attribute defined at extension acceleratorcms.

See Also:

• Constant Field Values

MAXIMUMNUMBERPRODUCTS

public static final String MAXIMUMNUMBERPRODUCTS

Generated constant - Attribute key of ProductReferencesComponent.maximumNumberProducts attribute defined at extension acceleratorcms.

See Also:

• Constant Field Values

DISPLAYPRODUCTTITLES

public static final String DISPLAYPRODUCTTITLES

Generated constant - Attribute key of ProductReferencesComponent.displayProductTitles attribute defined at extension acceleratorcms.

See Also:

• Constant Field Values

DISPLAYPRODUCTPRICES

public static final String DISPLAYPRODUCTPRICES

Generated constant - Attribute key of ProductReferencesComponent.displayProductPrices attribute defined at extension acceleratorcms.

See Also:

• Constant Field Values

Constructor Details

ProductReferencesComponentModel

public ProductReferencesComponentModel()

Generated constructor - Default constructor for generic creation.

ProductReferencesComponentModel

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

ProductReferencesComponentModel

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

ProductReferencesComponentModel

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

getMaximumNumberProducts

@Accessor(qualifier="maximumNumberProducts",
          type=GETTER)
public 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 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 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 String getTitle(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:

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(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(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(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(String value,
 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:

IllegalArgumentException - if localization key cannot be mapped to data language