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

Class ProductCarouselComponentModel

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.cms2lib.model.components.ProductCarouselComponentModel

All Implemented Interfaces:

Serializable

public class ProductCarouselComponentModel
extends SimpleCMSComponentModel

Generated model class for type ProductCarouselComponent first defined at extension cms2lib.

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	CATEGORIES	Generated constant - Attribute key of ProductCarouselComponent.categories attribute defined at extension cms2lib.
static final String	CATEGORYCODE	Generated constant - Attribute key of ProductCarouselComponent.categoryCode attribute defined at extension acceleratorcms.
static final String	CATEGORYCODES	Generated constant - Attribute key of ProductCarouselComponent.categoryCodes attribute defined at extension cms2lib.
static final String	POPUP	Generated constant - Attribute key of ProductCarouselComponent.popup attribute defined at extension acceleratorcms.
static final String	PRODUCTCODES	Generated constant - Attribute key of ProductCarouselComponent.productCodes attribute defined at extension cms2lib.
static final String	PRODUCTS	Generated constant - Attribute key of ProductCarouselComponent.products attribute defined at extension cms2lib.
static final String	SCROLL	Generated constant - Attribute key of ProductCarouselComponent.scroll attribute defined at extension cms2lib.
static final String	SEARCHQUERY	Generated constant - Attribute key of ProductCarouselComponent.searchQuery attribute defined at extension acceleratorcms.
static final String	TITLE	Generated constant - Attribute key of ProductCarouselComponent.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
ProductCarouselComponentModel()	Generated constructor - Default constructor for generic creation.
ProductCarouselComponentModel(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
ProductCarouselComponentModel(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
ProductCarouselComponentModel(de.hybris.platform.servicelayer.model.ItemModelContext ctx)	Generated constructor - Default constructor for creation with existing context

Method Summary

Modifier and Type	Method	Description
List<CategoryModel>	getCategories()	Generated method - Getter of the ProductCarouselComponent.categories attribute defined at extension cms2lib.
String	getCategoryCode()	Generated method - Getter of the ProductCarouselComponent.categoryCode attribute defined at extension acceleratorcms.
List<String>	getCategoryCodes()	Generated method - Getter of the ProductCarouselComponent.categoryCodes attribute defined at extension cms2lib.
List<String>	getProductCodes()	Generated method - Getter of the ProductCarouselComponent.productCodes attribute defined at extension cms2lib.
List<ProductModel>	getProducts()	Generated method - Getter of the ProductCarouselComponent.products attribute defined at extension cms2lib.
CarouselScroll	getScroll()	Generated method - Getter of the ProductCarouselComponent.scroll attribute defined at extension cms2lib.
String	getSearchQuery()	Generated method - Getter of the ProductCarouselComponent.searchQuery attribute defined at extension acceleratorcms.
String	getTitle()	Generated method - Getter of the ProductCarouselComponent.title attribute defined at extension acceleratorcms.
String	getTitle(Locale loc)	Generated method - Getter of the ProductCarouselComponent.title attribute defined at extension acceleratorcms.
boolean	isPopup()	Generated method - Getter of the ProductCarouselComponent.popup attribute defined at extension acceleratorcms.
void	setCategories(List<CategoryModel> value)	Generated method - Setter of ProductCarouselComponent.categories attribute defined at extension cms2lib.
void	setCategoryCode(String value)	Generated method - Setter of ProductCarouselComponent.categoryCode attribute defined at extension acceleratorcms.
void	setPopup(boolean value)	Generated method - Setter of ProductCarouselComponent.popup attribute defined at extension acceleratorcms.
void	setProducts(List<ProductModel> value)	Generated method - Setter of ProductCarouselComponent.products attribute defined at extension cms2lib.
void	setScroll(CarouselScroll value)	Generated method - Setter of ProductCarouselComponent.scroll attribute defined at extension cms2lib.
void	setSearchQuery(String value)	Generated method - Setter of ProductCarouselComponent.searchQuery attribute defined at extension acceleratorcms.
void	setTitle(String value)	Generated method - Setter of ProductCarouselComponent.title attribute defined at extension acceleratorcms.
void	setTitle(String value, Locale loc)	Generated method - Setter of ProductCarouselComponent.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

SCROLL

public static final String SCROLL

Generated constant - Attribute key of ProductCarouselComponent.scroll attribute defined at extension cms2lib.

See Also:

• Constant Field Values

PRODUCTCODES

public static final String PRODUCTCODES

Generated constant - Attribute key of ProductCarouselComponent.productCodes attribute defined at extension cms2lib.

See Also:

• Constant Field Values

CATEGORYCODES

public static final String CATEGORYCODES

Generated constant - Attribute key of ProductCarouselComponent.categoryCodes attribute defined at extension cms2lib.

See Also:

• Constant Field Values

PRODUCTS

public static final String PRODUCTS

Generated constant - Attribute key of ProductCarouselComponent.products attribute defined at extension cms2lib.

See Also:

• Constant Field Values

CATEGORIES

public static final String CATEGORIES

Generated constant - Attribute key of ProductCarouselComponent.categories attribute defined at extension cms2lib.

See Also:

• Constant Field Values

TITLE

public static final String TITLE

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

See Also:

• Constant Field Values

SEARCHQUERY

public static final String SEARCHQUERY

Generated constant - Attribute key of ProductCarouselComponent.searchQuery attribute defined at extension acceleratorcms.

See Also:

• Constant Field Values

CATEGORYCODE

public static final String CATEGORYCODE

Generated constant - Attribute key of ProductCarouselComponent.categoryCode attribute defined at extension acceleratorcms.

See Also:

• Constant Field Values

POPUP

public static final String POPUP

Generated constant - Attribute key of ProductCarouselComponent.popup attribute defined at extension acceleratorcms.

See Also:

• Constant Field Values

Constructor Details

ProductCarouselComponentModel

public ProductCarouselComponentModel()

Generated constructor - Default constructor for generic creation.

ProductCarouselComponentModel

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

ProductCarouselComponentModel

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

ProductCarouselComponentModel

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

getCategories

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

getProductCodes

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

IllegalArgumentException - if localization key cannot be mapped to data language

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

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

IllegalArgumentException - if localization key cannot be mapped to data language