de.hybris.platform.cms2lib.model.components

Class ProductListComponentModel

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.ProductListComponentModel

All Implemented Interfaces:

Serializable

public class ProductListComponentModel
extends SimpleCMSComponentModel

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

See Also:

Serialized Form

Nested Class Summary

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

AbstractItemModel.NewModelContextFactory

Field Summary

Fields

Modifier and Type	Field and Description
static String	_TYPECODE Generated model type code constant.
static String	CATEGORY Generated constant - Attribute key of ProductListComponent.category attribute defined at extension cms2lib.
static String	CATEGORYCODE Generated constant - Attribute key of ProductListComponent.categoryCode attribute defined at extension cms2lib.
static String	HEADLINE Generated constant - Attribute key of ProductListComponent.headline attribute defined at extension cms2lib.
static String	LAYOUT Generated constant - Attribute key of ProductListComponent.layout attribute defined at extension cms2lib.
static String	PAGINATION Generated constant - Attribute key of ProductListComponent.pagination attribute defined at extension cms2lib.
static String	PRODUCTCODES Generated constant - Attribute key of ProductListComponent.productCodes attribute defined at extension cms2lib.
static String	PRODUCTS Generated constant - Attribute key of ProductListComponent.products attribute defined at extension cms2lib.
static String	PRODUCTSFROMCONTEXT Generated constant - Attribute key of ProductListComponent.productsFromContext attribute defined at extension cms2lib.
static String	SEARCHQUERY Generated constant - Attribute key of ProductListComponent.searchQuery attribute defined at extension cms2lib.

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

_ELEMENTSFORSLOT, ACTIONS, CONTAINER, ONLYONERESTRICTIONMUSTAPPLY, RESTRICTED, RESTRICTIONS, SLOTS, TYPE, TYPECODE, VISIBLE

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

CATALOGVERSION, NAME, UID

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

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

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

LANGUAGE_FALLBACK_ENABLED_SERVICE_LAYER, MODEL_CONTEXT_FACTORY

Constructor Summary

Constructors

Constructor and Description
ProductListComponentModel() Generated constructor - Default constructor for generic creation.
ProductListComponentModel(CatalogVersionModel _catalogVersion, boolean _pagination, boolean _productsFromContext, String _uid) Deprecated. Since 4.1.1 Please use the default constructor without parameters
ProductListComponentModel(CatalogVersionModel _catalogVersion, ItemModel _owner, boolean _pagination, boolean _productsFromContext, String _uid) Deprecated. Since 4.1.1 Please use the default constructor without parameters
ProductListComponentModel(ItemModelContext ctx) Generated constructor - Default constructor for creation with existing context

Method Summary

Modifier and Type	Method and Description
CategoryModel	getCategory() Generated method - Getter of the ProductListComponent.category attribute defined at extension cms2lib.
String	getCategoryCode() Generated method - Getter of the ProductListComponent.categoryCode attribute defined at extension cms2lib.
String	getHeadline() Generated method - Getter of the ProductListComponent.headline attribute defined at extension cms2lib.
String	getHeadline(Locale loc) Generated method - Getter of the ProductListComponent.headline attribute defined at extension cms2lib.
ProductListLayouts	getLayout() Generated method - Getter of the ProductListComponent.layout attribute defined at extension cms2lib.
List<String>	getProductCodes() Generated method - Getter of the ProductListComponent.productCodes attribute defined at extension cms2lib.
List<ProductModel>	getProducts() Generated method - Getter of the ProductListComponent.products attribute defined at extension cms2lib.
String	getSearchQuery() Generated method - Getter of the ProductListComponent.searchQuery attribute defined at extension cms2lib.
String	getSearchQuery(Locale loc) Generated method - Getter of the ProductListComponent.searchQuery attribute defined at extension cms2lib.
boolean	isPagination() Generated method - Getter of the ProductListComponent.pagination attribute defined at extension cms2lib.
boolean	isProductsFromContext() Generated method - Getter of the ProductListComponent.productsFromContext attribute defined at extension cms2lib.
void	setCategory(CategoryModel value) Generated method - Setter of ProductListComponent.category attribute defined at extension cms2lib.
void	setHeadline(String value) Generated method - Setter of ProductListComponent.headline attribute defined at extension cms2lib.
void	setHeadline(String value, Locale loc) Generated method - Setter of ProductListComponent.headline attribute defined at extension cms2lib.
void	setLayout(ProductListLayouts value) Generated method - Setter of ProductListComponent.layout attribute defined at extension cms2lib.
void	setPagination(boolean value) Generated method - Setter of ProductListComponent.pagination attribute defined at extension cms2lib.
void	setProducts(List<ProductModel> value) Generated method - Setter of ProductListComponent.products attribute defined at extension cms2lib.
void	setProductsFromContext(boolean value) Generated method - Setter of ProductListComponent.productsFromContext attribute defined at extension cms2lib.
void	setSearchQuery(String value) Generated method - Setter of ProductListComponent.searchQuery attribute defined at extension cms2lib.
void	setSearchQuery(String value, Locale loc) Generated method - Setter of ProductListComponent.searchQuery attribute defined at extension cms2lib.

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, getRestrictions, getSlots, getType, getType, getTypeCode, getVisible, isContainer, isOnlyOneRestrictionMustApply, isRestricted, setActions, setOnlyOneRestrictionMustApply, setRestrictions, setSlots, setVisible

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

getCatalogVersion, getName, getUid, setCatalogVersion, setName, setUid

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

getComments, getCreationtime, getModifiedtime, getOwner, 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 Detail

_TYPECODE

public static final String _TYPECODE

Generated model type code constant.

See Also:

Constant Field Values

HEADLINE

public static final String HEADLINE

Generated constant - Attribute key of ProductListComponent.headline attribute defined at extension cms2lib.

See Also:

Constant Field Values

CATEGORYCODE

public static final String CATEGORYCODE

Generated constant - Attribute key of ProductListComponent.categoryCode attribute defined at extension cms2lib.

See Also:

Constant Field Values

PRODUCTSFROMCONTEXT

public static final String PRODUCTSFROMCONTEXT

Generated constant - Attribute key of ProductListComponent.productsFromContext attribute defined at extension cms2lib.

See Also:

Constant Field Values

SEARCHQUERY

public static final String SEARCHQUERY

Generated constant - Attribute key of ProductListComponent.searchQuery attribute defined at extension cms2lib.

See Also:

Constant Field Values

PAGINATION

public static final String PAGINATION

Generated constant - Attribute key of ProductListComponent.pagination attribute defined at extension cms2lib.

See Also:

Constant Field Values

LAYOUT

public static final String LAYOUT

Generated constant - Attribute key of ProductListComponent.layout attribute defined at extension cms2lib.

See Also:

Constant Field Values

PRODUCTCODES

public static final String PRODUCTCODES

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

See Also:

Constant Field Values

PRODUCTS

public static final String PRODUCTS

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

See Also:

Constant Field Values

CATEGORY

public static final String CATEGORY

Generated constant - Attribute key of ProductListComponent.category attribute defined at extension cms2lib.

See Also:

Constant Field Values

Constructor Detail

ProductListComponentModel

public ProductListComponentModel()

Generated constructor - Default constructor for generic creation.

ProductListComponentModel

public ProductListComponentModel(ItemModelContext ctx)

Generated constructor - Default constructor for creation with existing context

Parameters:

ctx - the model context to be injected, must not be null

ProductListComponentModel

@Deprecated
public ProductListComponentModel(CatalogVersionModel _catalogVersion,
                                             boolean _pagination,
                                             boolean _productsFromContext,
                                             String _uid)

Deprecated. 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

_pagination - initial attribute declared by type ProductListComponent at extension cms2lib

_productsFromContext - initial attribute declared by type ProductListComponent at extension cms2lib

_uid - initial attribute declared by type CMSItem at extension cms2

ProductListComponentModel

@Deprecated
public ProductListComponentModel(CatalogVersionModel _catalogVersion,
                                             ItemModel _owner,
                                             boolean _pagination,
                                             boolean _productsFromContext,
                                             String _uid)

Deprecated. 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

_pagination - initial attribute declared by type ProductListComponent at extension cms2lib

_productsFromContext - initial attribute declared by type ProductListComponent at extension cms2lib

_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 ProductListComponent.category attribute defined at extension cms2lib.

Returns:

the category

getCategoryCode

@Accessor(qualifier="categoryCode",
          type=GETTER)
public String getCategoryCode()

Generated method - Getter of the ProductListComponent.categoryCode attribute defined at extension cms2lib.

Returns:

the categoryCode

getHeadline

@Accessor(qualifier="headline",
          type=GETTER)
public String getHeadline()

Generated method - Getter of the ProductListComponent.headline attribute defined at extension cms2lib.

Returns:

the headline

getHeadline

@Accessor(qualifier="headline",
          type=GETTER)
public String getHeadline(Locale loc)

Generated method - Getter of the ProductListComponent.headline attribute defined at extension cms2lib.

Parameters:

loc - the value localization key

Returns:

the headline

Throws:

IllegalArgumentException - if localization key cannot be mapped to data language

getLayout

@Accessor(qualifier="layout",
          type=GETTER)
public ProductListLayouts getLayout()

Generated method - Getter of the ProductListComponent.layout attribute defined at extension cms2lib.

Returns:

the layout

getProductCodes

@Accessor(qualifier="productCodes",
          type=GETTER)
public List<String> getProductCodes()

Generated method - Getter of the ProductListComponent.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 ProductListComponent.products attribute defined at extension cms2lib. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.

Returns:

the products

getSearchQuery

@Accessor(qualifier="searchQuery",
          type=GETTER)
public String getSearchQuery()

Generated method - Getter of the ProductListComponent.searchQuery attribute defined at extension cms2lib.

Returns:

the searchQuery

getSearchQuery

@Accessor(qualifier="searchQuery",
          type=GETTER)
public String getSearchQuery(Locale loc)

Generated method - Getter of the ProductListComponent.searchQuery attribute defined at extension cms2lib.

Parameters:

loc - the value localization key

Returns:

the searchQuery

Throws:

IllegalArgumentException - if localization key cannot be mapped to data language

isPagination

@Accessor(qualifier="pagination",
          type=GETTER)
public boolean isPagination()

Generated method - Getter of the ProductListComponent.pagination attribute defined at extension cms2lib.

Returns:

the pagination

isProductsFromContext

@Accessor(qualifier="productsFromContext",
          type=GETTER)
public boolean isProductsFromContext()

Generated method - Getter of the ProductListComponent.productsFromContext attribute defined at extension cms2lib.

Returns:

the productsFromContext

setCategory

@Accessor(qualifier="category",
          type=SETTER)
public void setCategory(CategoryModel value)

Generated method - Setter of ProductListComponent.category attribute defined at extension cms2lib.

Parameters:

value - the category

setHeadline

@Accessor(qualifier="headline",
          type=SETTER)
public void setHeadline(String value)

Generated method - Setter of ProductListComponent.headline attribute defined at extension cms2lib.

Parameters:

value - the headline

setHeadline

@Accessor(qualifier="headline",
          type=SETTER)
public void setHeadline(String value,
                                                                               Locale loc)

Generated method - Setter of ProductListComponent.headline attribute defined at extension cms2lib.

Parameters:

value - the headline

loc - the value localization key

Throws:

IllegalArgumentException - if localization key cannot be mapped to data language

setLayout

@Accessor(qualifier="layout",
          type=SETTER)
public void setLayout(ProductListLayouts value)

Generated method - Setter of ProductListComponent.layout attribute defined at extension cms2lib.

Parameters:

value - the layout

setPagination

@Accessor(qualifier="pagination",
          type=SETTER)
public void setPagination(boolean value)

Generated method - Setter of ProductListComponent.pagination attribute defined at extension cms2lib.

Parameters:

value - the pagination

setProducts

@Accessor(qualifier="products",
          type=SETTER)
public void setProducts(List<ProductModel> value)

Generated method - Setter of ProductListComponent.products attribute defined at extension cms2lib.

Parameters:

value - the products

setProductsFromContext

@Accessor(qualifier="productsFromContext",
          type=SETTER)
public void setProductsFromContext(boolean value)

Generated method - Setter of ProductListComponent.productsFromContext attribute defined at extension cms2lib.

Parameters:

value - the productsFromContext

setSearchQuery

@Accessor(qualifier="searchQuery",
          type=SETTER)
public void setSearchQuery(String value)

Generated method - Setter of ProductListComponent.searchQuery attribute defined at extension cms2lib.

Parameters:

value - the searchQuery

setSearchQuery

@Accessor(qualifier="searchQuery",
          type=SETTER)
public void setSearchQuery(String value,
                                                                                     Locale loc)

Generated method - Setter of ProductListComponent.searchQuery attribute defined at extension cms2lib.

Parameters:

value - the searchQuery

loc - the value localization key

Throws:

IllegalArgumentException - if localization key cannot be mapped to data language