Package com.hybris.merchandising.addon.model

Class MerchandisingCarouselComponentModel

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

com.hybris.merchandising.addon.model.MerchandisingCarouselComponentModel

All Implemented Interfaces:

Serializable

public class MerchandisingCarouselComponentModel
extends SimpleCMSComponentModel

Generated model class for type MerchandisingCarouselComponent first defined at extension merchandisingaddon.

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	Description
static final String	_TYPECODE	Generated model type code constant.
static final String	BACKGROUNDCOLOUR	Generated constant - Attribute key of MerchandisingCarouselComponent.backgroundColour attribute defined at extension merchandisingaddon.
static final String	NUMBERTODISPLAY	Generated constant - Attribute key of MerchandisingCarouselComponent.numberToDisplay attribute defined at extension merchandisingaddon.
static final String	SCROLL	Generated constant - Attribute key of MerchandisingCarouselComponent.scroll attribute defined at extension merchandisingaddon.
static final String	STRATEGY	Generated constant - Attribute key of MerchandisingCarouselComponent.strategy attribute defined at extension merchandisingaddon.
static final String	TEXTCOLOUR	Generated constant - Attribute key of MerchandisingCarouselComponent.textColour attribute defined at extension merchandisingaddon.
static final String	TITLE	Generated constant - Attribute key of MerchandisingCarouselComponent.title attribute defined at extension merchandisingaddon.
static final String	VIEWPORTPERCENTAGE	Generated constant - Attribute key of MerchandisingCarouselComponent.viewportPercentage attribute defined at extension merchandisingaddon.

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
MerchandisingCarouselComponentModel()	Generated constructor - Default constructor for generic creation.
MerchandisingCarouselComponentModel(CatalogVersionModel _catalogVersion, int _numberToDisplay, ItemModel _owner, String _strategy, 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
MerchandisingCarouselComponentModel(CatalogVersionModel _catalogVersion, int _numberToDisplay, String _strategy, 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
MerchandisingCarouselComponentModel(ItemModelContext ctx)	Generated constructor - Default constructor for creation with existing context

Method Summary

Modifier and Type	Method	Description
String	getBackgroundColour()	Generated method - Getter of the MerchandisingCarouselComponent.backgroundColour attribute defined at extension merchandisingaddon.
int	getNumberToDisplay()	Generated method - Getter of the MerchandisingCarouselComponent.numberToDisplay attribute defined at extension merchandisingaddon.
ScrollType	getScroll()	Generated method - Getter of the MerchandisingCarouselComponent.scroll attribute defined at extension merchandisingaddon.
String	getStrategy()	Generated method - Getter of the MerchandisingCarouselComponent.strategy attribute defined at extension merchandisingaddon.
String	getTextColour()	Generated method - Getter of the MerchandisingCarouselComponent.textColour attribute defined at extension merchandisingaddon.
String	getTitle()	Generated method - Getter of the MerchandisingCarouselComponent.title attribute defined at extension merchandisingaddon.
String	getTitle(Locale loc)	Generated method - Getter of the MerchandisingCarouselComponent.title attribute defined at extension merchandisingaddon.
int	getViewportPercentage()	Generated method - Getter of the MerchandisingCarouselComponent.viewportPercentage attribute defined at extension merchandisingaddon.
void	setBackgroundColour(String value)	Generated method - Setter of MerchandisingCarouselComponent.backgroundColour attribute defined at extension merchandisingaddon.
void	setNumberToDisplay(int value)	Generated method - Setter of MerchandisingCarouselComponent.numberToDisplay attribute defined at extension merchandisingaddon.
void	setScroll(ScrollType value)	Generated method - Setter of MerchandisingCarouselComponent.scroll attribute defined at extension merchandisingaddon.
void	setStrategy(String value)	Generated method - Setter of MerchandisingCarouselComponent.strategy attribute defined at extension merchandisingaddon.
void	setTextColour(String value)	Generated method - Setter of MerchandisingCarouselComponent.textColour attribute defined at extension merchandisingaddon.
void	setTitle(String value)	Generated method - Setter of MerchandisingCarouselComponent.title attribute defined at extension merchandisingaddon.
void	setTitle(String value, Locale loc)	Generated method - Setter of MerchandisingCarouselComponent.title attribute defined at extension merchandisingaddon.
void	setViewportPercentage(int value)	Generated method - Setter of MerchandisingCarouselComponent.viewportPercentage attribute defined at extension merchandisingaddon.

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

NUMBERTODISPLAY

public static final String NUMBERTODISPLAY

Generated constant - Attribute key of MerchandisingCarouselComponent.numberToDisplay attribute defined at extension merchandisingaddon.

See Also:

• Constant Field Values

STRATEGY

public static final String STRATEGY

Generated constant - Attribute key of MerchandisingCarouselComponent.strategy attribute defined at extension merchandisingaddon.

See Also:

• Constant Field Values

TITLE

public static final String TITLE

Generated constant - Attribute key of MerchandisingCarouselComponent.title attribute defined at extension merchandisingaddon.

See Also:

• Constant Field Values

BACKGROUNDCOLOUR

public static final String BACKGROUNDCOLOUR

Generated constant - Attribute key of MerchandisingCarouselComponent.backgroundColour attribute defined at extension merchandisingaddon.

See Also:

• Constant Field Values

TEXTCOLOUR

public static final String TEXTCOLOUR

Generated constant - Attribute key of MerchandisingCarouselComponent.textColour attribute defined at extension merchandisingaddon.

See Also:

• Constant Field Values

SCROLL

public static final String SCROLL

Generated constant - Attribute key of MerchandisingCarouselComponent.scroll attribute defined at extension merchandisingaddon.

See Also:

• Constant Field Values

VIEWPORTPERCENTAGE

public static final String VIEWPORTPERCENTAGE

Generated constant - Attribute key of MerchandisingCarouselComponent.viewportPercentage attribute defined at extension merchandisingaddon.

See Also:

• Constant Field Values

Constructor Details

MerchandisingCarouselComponentModel

public MerchandisingCarouselComponentModel()

Generated constructor - Default constructor for generic creation.

MerchandisingCarouselComponentModel

public MerchandisingCarouselComponentModel(ItemModelContext ctx)

Generated constructor - Default constructor for creation with existing context

Parameters:

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

MerchandisingCarouselComponentModel

@Deprecated(since="4.1.1",
            forRemoval=true)
public MerchandisingCarouselComponentModel(CatalogVersionModel _catalogVersion,
 int _numberToDisplay,
 String _strategy,
 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

_numberToDisplay - initial attribute declared by type MerchandisingCarouselComponent at extension merchandisingaddon

_strategy - initial attribute declared by type MerchandisingCarouselComponent at extension merchandisingaddon

_uid - initial attribute declared by type CMSItem at extension cms2

MerchandisingCarouselComponentModel

@Deprecated(since="4.1.1",
            forRemoval=true)
public MerchandisingCarouselComponentModel(CatalogVersionModel _catalogVersion,
 int _numberToDisplay,
 ItemModel _owner,
 String _strategy,
 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

_numberToDisplay - initial attribute declared by type MerchandisingCarouselComponent at extension merchandisingaddon

_owner - initial attribute declared by type Item at extension core

_strategy - initial attribute declared by type MerchandisingCarouselComponent at extension merchandisingaddon

_uid - initial attribute declared by type CMSItem at extension cms2

Method Details

getBackgroundColour

@Accessor(qualifier="backgroundColour",
          type=GETTER)
public String getBackgroundColour()

Generated method - Getter of the MerchandisingCarouselComponent.backgroundColour attribute defined at extension merchandisingaddon.

Returns:

the backgroundColour - Carousel background colour.

getNumberToDisplay

@Accessor(qualifier="numberToDisplay",
          type=GETTER)
public int getNumberToDisplay()

Generated method - Getter of the MerchandisingCarouselComponent.numberToDisplay attribute defined at extension merchandisingaddon.

Returns:

the numberToDisplay - How many items to show in the carousel.

getScroll

@Accessor(qualifier="scroll",
          type=GETTER)
public ScrollType getScroll()

Generated method - Getter of the MerchandisingCarouselComponent.scroll attribute defined at extension merchandisingaddon.

Returns:

the scroll

getStrategy

@Accessor(qualifier="strategy",
          type=GETTER)
public String getStrategy()

Generated method - Getter of the MerchandisingCarouselComponent.strategy attribute defined at extension merchandisingaddon.

Returns:

the strategy - Strategy to use for carousel.

getTextColour

@Accessor(qualifier="textColour",
          type=GETTER)
public String getTextColour()

Generated method - Getter of the MerchandisingCarouselComponent.textColour attribute defined at extension merchandisingaddon.

Returns:

the textColour - Carousel text colour.

getTitle

@Accessor(qualifier="title",
          type=GETTER)
public String getTitle()

Generated method - Getter of the MerchandisingCarouselComponent.title attribute defined at extension merchandisingaddon.

Returns:

the title - Carousel title.

getTitle

@Accessor(qualifier="title",
          type=GETTER)
public String getTitle(Locale loc)

Generated method - Getter of the MerchandisingCarouselComponent.title attribute defined at extension merchandisingaddon.

Parameters:

loc - the value localization key

Returns:

the title - Carousel title.

Throws:

IllegalArgumentException - if localization key cannot be mapped to data language

getViewportPercentage

@Accessor(qualifier="viewportPercentage",
          type=GETTER)
public int getViewportPercentage()

Generated method - Getter of the MerchandisingCarouselComponent.viewportPercentage attribute defined at extension merchandisingaddon.

Returns:

the viewportPercentage - Viewport percentage to trigger carousel view event.

setBackgroundColour

@Accessor(qualifier="backgroundColour",
          type=SETTER)
public void setBackgroundColour(String value)

Generated method - Setter of MerchandisingCarouselComponent.backgroundColour attribute defined at extension merchandisingaddon.

Parameters:

value - the backgroundColour - Carousel background colour.

setNumberToDisplay

@Accessor(qualifier="numberToDisplay",
          type=SETTER)
public void setNumberToDisplay(int value)

Generated method - Setter of MerchandisingCarouselComponent.numberToDisplay attribute defined at extension merchandisingaddon.

Parameters:

value - the numberToDisplay - How many items to show in the carousel.

setScroll

@Accessor(qualifier="scroll",
          type=SETTER)
public void setScroll(ScrollType value)

Generated method - Setter of MerchandisingCarouselComponent.scroll attribute defined at extension merchandisingaddon.

Parameters:

value - the scroll

setStrategy

@Accessor(qualifier="strategy",
          type=SETTER)
public void setStrategy(String value)

Generated method - Setter of MerchandisingCarouselComponent.strategy attribute defined at extension merchandisingaddon.

Parameters:

value - the strategy - Strategy to use for carousel.

setTextColour

@Accessor(qualifier="textColour",
          type=SETTER)
public void setTextColour(String value)

Generated method - Setter of MerchandisingCarouselComponent.textColour attribute defined at extension merchandisingaddon.

Parameters:

value - the textColour - Carousel text colour.

setTitle

@Accessor(qualifier="title",
          type=SETTER)
public void setTitle(String value)

Generated method - Setter of MerchandisingCarouselComponent.title attribute defined at extension merchandisingaddon.

Parameters:

value - the title - Carousel title.

setTitle

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

Generated method - Setter of MerchandisingCarouselComponent.title attribute defined at extension merchandisingaddon.

Parameters:

value - the title - Carousel title.

loc - the value localization key

Throws:

IllegalArgumentException - if localization key cannot be mapped to data language

setViewportPercentage

@Accessor(qualifier="viewportPercentage",
          type=SETTER)
public void setViewportPercentage(int value)

Generated method - Setter of MerchandisingCarouselComponent.viewportPercentage attribute defined at extension merchandisingaddon.

Parameters:

value - the viewportPercentage - Viewport percentage to trigger carousel view event.