Package de.hybris.platform.promotions.model

Class ProductBOGOFPromotionModel

java.lang.Object

de.hybris.platform.servicelayer.model.AbstractItemModel

de.hybris.platform.core.model.ItemModel

de.hybris.platform.promotions.model.AbstractPromotionModel

de.hybris.platform.promotions.model.ProductPromotionModel

de.hybris.platform.promotions.model.ProductBOGOFPromotionModel

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AcceleratorProductBOGOFPromotionModel

public class ProductBOGOFPromotionModel
extends ProductPromotionModel

Generated model class for type ProductBOGOFPromotion first defined at extension promotions.

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	FREECOUNT	Generated constant - Attribute key of ProductBOGOFPromotion.freeCount attribute defined at extension promotions.
static final String	MESSAGECOULDHAVEFIRED	Generated constant - Attribute key of ProductBOGOFPromotion.messageCouldHaveFired attribute defined at extension promotions.
static final String	MESSAGEFIRED	Generated constant - Attribute key of ProductBOGOFPromotion.messageFired attribute defined at extension promotions.
static final String	QUALIFYINGCOUNT	Generated constant - Attribute key of ProductBOGOFPromotion.qualifyingCount attribute defined at extension promotions.

Fields inherited from class de.hybris.platform.promotions.model.ProductPromotionModel

_CATEGORYPROMOTIONRELATION, _PRODUCTPROMOTIONRELATION, CATEGORIES, PRODUCTBANNER, PRODUCTS

Fields inherited from class de.hybris.platform.promotions.model.AbstractPromotionModel

_PROMOTIONGROUPPROMOTIONSRELATION, CODE, DESCRIPTION, DETAILSURL, ENABLED, ENDDATE, IMMUTABLEKEY, IMMUTABLEKEYHASH, NAME, PRIORITY, PROMOTIONGROUP, PROMOTIONTYPE, RESTRICTIONS, STARTDATE, TITLE

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
ProductBOGOFPromotionModel()	Generated constructor - Default constructor for generic creation.
ProductBOGOFPromotionModel(de.hybris.platform.servicelayer.model.ItemModelContext ctx)	Generated constructor - Default constructor for creation with existing context
ProductBOGOFPromotionModel(String _code)	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
ProductBOGOFPromotionModel(String _code, ItemModel _owner)	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

Method Summary

Modifier and Type	Method	Description
Integer	getFreeCount()	Generated method - Getter of the ProductBOGOFPromotion.freeCount attribute defined at extension promotions.
String	getMessageCouldHaveFired()	Generated method - Getter of the ProductBOGOFPromotion.messageCouldHaveFired attribute defined at extension promotions.
String	getMessageCouldHaveFired(Locale loc)	Generated method - Getter of the ProductBOGOFPromotion.messageCouldHaveFired attribute defined at extension promotions.
String	getMessageFired()	Generated method - Getter of the ProductBOGOFPromotion.messageFired attribute defined at extension promotions.
String	getMessageFired(Locale loc)	Generated method - Getter of the ProductBOGOFPromotion.messageFired attribute defined at extension promotions.
Integer	getQualifyingCount()	Generated method - Getter of the ProductBOGOFPromotion.qualifyingCount attribute defined at extension promotions.
void	setFreeCount(Integer value)	Generated method - Setter of ProductBOGOFPromotion.freeCount attribute defined at extension promotions.
void	setMessageCouldHaveFired(String value)	Generated method - Setter of ProductBOGOFPromotion.messageCouldHaveFired attribute defined at extension promotions.
void	setMessageCouldHaveFired(String value, Locale loc)	Generated method - Setter of ProductBOGOFPromotion.messageCouldHaveFired attribute defined at extension promotions.
void	setMessageFired(String value)	Generated method - Setter of ProductBOGOFPromotion.messageFired attribute defined at extension promotions.
void	setMessageFired(String value, Locale loc)	Generated method - Setter of ProductBOGOFPromotion.messageFired attribute defined at extension promotions.
void	setQualifyingCount(Integer value)	Generated method - Setter of ProductBOGOFPromotion.qualifyingCount attribute defined at extension promotions.

Methods inherited from class de.hybris.platform.promotions.model.ProductPromotionModel

getCategories, getProductBanner, getProducts, setCategories, setProductBanner, setProducts

Methods inherited from class de.hybris.platform.promotions.model.AbstractPromotionModel

getCode, getDescription, getDetailsURL, getEnabled, getEndDate, getImmutableKey, getImmutableKeyHash, getName, getName, getPriority, getPromotionGroup, getPromotionType, getPromotionType, getRestrictions, getStartDate, getTitle, setCode, setDescription, setDetailsURL, setEnabled, setEndDate, setImmutableKey, setImmutableKeyHash, setName, setName, setPriority, setPromotionGroup, setRestrictions, setStartDate, setTitle

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

QUALIFYINGCOUNT

public static final String QUALIFYINGCOUNT

Generated constant - Attribute key of ProductBOGOFPromotion.qualifyingCount attribute defined at extension promotions.

See Also:

• Constant Field Values

FREECOUNT

public static final String FREECOUNT

Generated constant - Attribute key of ProductBOGOFPromotion.freeCount attribute defined at extension promotions.

See Also:

• Constant Field Values

MESSAGEFIRED

public static final String MESSAGEFIRED

Generated constant - Attribute key of ProductBOGOFPromotion.messageFired attribute defined at extension promotions.

See Also:

• Constant Field Values

MESSAGECOULDHAVEFIRED

public static final String MESSAGECOULDHAVEFIRED

Generated constant - Attribute key of ProductBOGOFPromotion.messageCouldHaveFired attribute defined at extension promotions.

See Also:

• Constant Field Values

Constructor Details

ProductBOGOFPromotionModel

public ProductBOGOFPromotionModel()

Generated constructor - Default constructor for generic creation.

ProductBOGOFPromotionModel

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

ProductBOGOFPromotionModel

@Deprecated(since="4.1.1",
            forRemoval=true)
public ProductBOGOFPromotionModel(String _code)

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:

_code - initial attribute declared by type AbstractPromotion at extension promotions

ProductBOGOFPromotionModel

@Deprecated(since="4.1.1",
            forRemoval=true)
public ProductBOGOFPromotionModel(String _code,
 ItemModel _owner)

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:

_code - initial attribute declared by type AbstractPromotion at extension promotions

_owner - initial attribute declared by type Item at extension core

Method Details

getFreeCount

@Accessor(qualifier="freeCount",
          type=GETTER)
public Integer getFreeCount()

Generated method - Getter of the ProductBOGOFPromotion.freeCount attribute defined at extension promotions.

Returns:

the freeCount - The number of products within the cart to give away free. (For standard BOGOF this is 1).

getMessageCouldHaveFired

@Accessor(qualifier="messageCouldHaveFired",
          type=GETTER)
public String getMessageCouldHaveFired()

Generated method - Getter of the ProductBOGOFPromotion.messageCouldHaveFired attribute defined at extension promotions.

Returns:

the messageCouldHaveFired - The message to show when the promotion could have potentially fire.

getMessageCouldHaveFired

@Accessor(qualifier="messageCouldHaveFired",
          type=GETTER)
public String getMessageCouldHaveFired(Locale loc)

Generated method - Getter of the ProductBOGOFPromotion.messageCouldHaveFired attribute defined at extension promotions.

Parameters:

loc - the value localization key

Returns:

the messageCouldHaveFired - The message to show when the promotion could have potentially fire.

Throws:

IllegalArgumentException - if localization key cannot be mapped to data language

getMessageFired

@Accessor(qualifier="messageFired",
          type=GETTER)
public String getMessageFired()

Generated method - Getter of the ProductBOGOFPromotion.messageFired attribute defined at extension promotions.

Returns:

the messageFired - The message to show when the promotion has fired.

getMessageFired

@Accessor(qualifier="messageFired",
          type=GETTER)
public String getMessageFired(Locale loc)

Generated method - Getter of the ProductBOGOFPromotion.messageFired attribute defined at extension promotions.

Parameters:

loc - the value localization key

Returns:

the messageFired - The message to show when the promotion has fired.

Throws:

IllegalArgumentException - if localization key cannot be mapped to data language

getQualifyingCount

@Accessor(qualifier="qualifyingCount",
          type=GETTER)
public Integer getQualifyingCount()

Generated method - Getter of the ProductBOGOFPromotion.qualifyingCount attribute defined at extension promotions.

Returns:

the qualifyingCount - The number of products required in the cart to activate the promotion. (For standard BOGOF this is 2).

setFreeCount

@Accessor(qualifier="freeCount",
          type=SETTER)
public void setFreeCount(Integer value)

Generated method - Setter of ProductBOGOFPromotion.freeCount attribute defined at extension promotions.

Parameters:

value - the freeCount - The number of products within the cart to give away free. (For standard BOGOF this is 1).

setMessageCouldHaveFired

@Accessor(qualifier="messageCouldHaveFired",
          type=SETTER)
public void setMessageCouldHaveFired(String value)

Generated method - Setter of ProductBOGOFPromotion.messageCouldHaveFired attribute defined at extension promotions.

Parameters:

value - the messageCouldHaveFired - The message to show when the promotion could have potentially fire.

setMessageCouldHaveFired

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

Generated method - Setter of ProductBOGOFPromotion.messageCouldHaveFired attribute defined at extension promotions.

Parameters:

value - the messageCouldHaveFired - The message to show when the promotion could have potentially fire.

loc - the value localization key

Throws:

IllegalArgumentException - if localization key cannot be mapped to data language

setMessageFired

@Accessor(qualifier="messageFired",
          type=SETTER)
public void setMessageFired(String value)

Generated method - Setter of ProductBOGOFPromotion.messageFired attribute defined at extension promotions.

Parameters:

value - the messageFired - The message to show when the promotion has fired.

setMessageFired

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

Generated method - Setter of ProductBOGOFPromotion.messageFired attribute defined at extension promotions.

Parameters:

value - the messageFired - The message to show when the promotion has fired.

loc - the value localization key

Throws:

IllegalArgumentException - if localization key cannot be mapped to data language

setQualifyingCount

@Accessor(qualifier="qualifyingCount",
          type=SETTER)
public void setQualifyingCount(Integer value)

Generated method - Setter of ProductBOGOFPromotion.qualifyingCount attribute defined at extension promotions.

Parameters:

value - the qualifyingCount - The number of products required in the cart to activate the promotion. (For standard BOGOF this is 2).