Package de.hybris.platform.ruleengineservices.model

Class AbstractRuleModel

java.lang.Object

de.hybris.platform.servicelayer.model.AbstractItemModel

de.hybris.platform.core.model.ItemModel

de.hybris.platform.ruleengineservices.model.AbstractRuleModel

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

SourceRuleModel

public class AbstractRuleModel
extends ItemModel

Generated model class for type AbstractRule first defined at extension ruleengineservices.

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	_RULEGROUP2ABSTRACTRULE	Generated relation code constant for relation RuleGroup2AbstractRule defining source attribute ruleGroup in extension ruleengineservices.
static final String	_TYPECODE	Generated model type code constant.
static final String	CODE	Generated constant - Attribute key of AbstractRule.code attribute defined at extension ruleengineservices.
static final String	DESCRIPTION	Generated constant - Attribute key of AbstractRule.description attribute defined at extension ruleengineservices.
static final String	ENDDATE	Generated constant - Attribute key of AbstractRule.endDate attribute defined at extension ruleengineservices.
static final String	ENGINERULES	Generated constant - Attribute key of AbstractRule.engineRules attribute defined at extension ruleengineservices.
static final String	MAXALLOWEDRUNS	Generated constant - Attribute key of AbstractRule.maxAllowedRuns attribute defined at extension ruleengineservices.
static final String	MESSAGEFIRED	Generated constant - Attribute key of AbstractRule.messageFired attribute defined at extension ruleengineservices.
static final String	NAME	Generated constant - Attribute key of AbstractRule.name attribute defined at extension ruleengineservices.
static final String	PRIORITY	Generated constant - Attribute key of AbstractRule.priority attribute defined at extension ruleengineservices.
static final String	RULEGROUP	Generated constant - Attribute key of AbstractRule.ruleGroup attribute defined at extension ruleengineservices.
static final String	RULESMODULES	Generated constant - Attribute key of AbstractRule.rulesModules attribute defined at extension ruleengineservices.
static final String	STACKABLE	Generated constant - Attribute key of AbstractRule.stackable attribute defined at extension ruleengineservices.
static final String	STARTDATE	Generated constant - Attribute key of AbstractRule.startDate attribute defined at extension ruleengineservices.
static final String	STATUS	Generated constant - Attribute key of AbstractRule.status attribute defined at extension ruleengineservices.
static final String	UUID	Generated constant - Attribute key of AbstractRule.uuid attribute defined at extension ruleengineservices.
static final String	VERSION	Generated constant - Attribute key of AbstractRule.version attribute defined at extension ruleengineservices.

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
AbstractRuleModel()	Generated constructor - Default constructor for generic creation.
AbstractRuleModel(ItemModelContext ctx)	Generated constructor - Default constructor for creation with existing context
AbstractRuleModel(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
AbstractRuleModel(String _code, ItemModel _owner, String _uuid)	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
String	getCode()	Generated method - Getter of the AbstractRule.code attribute defined at extension ruleengineservices.
String	getDescription()	Generated method - Getter of the AbstractRule.description attribute defined at extension ruleengineservices.
String	getDescription(Locale loc)	Generated method - Getter of the AbstractRule.description attribute defined at extension ruleengineservices.
Date	getEndDate()	Generated method - Getter of the AbstractRule.endDate attribute defined at extension ruleengineservices.
Set<AbstractRuleEngineRuleModel>	getEngineRules()	Generated method - Getter of the AbstractRule.engineRules attribute defined at extension ruleengineservices.
Integer	getMaxAllowedRuns()	Generated method - Getter of the AbstractRule.maxAllowedRuns attribute defined at extension ruleengineservices.
String	getMessageFired()	Generated method - Getter of the AbstractRule.messageFired attribute defined at extension ruleengineservices.
String	getMessageFired(Locale loc)	Generated method - Getter of the AbstractRule.messageFired attribute defined at extension ruleengineservices.
String	getName()	Generated method - Getter of the AbstractRule.name attribute defined at extension ruleengineservices.
String	getName(Locale loc)	Generated method - Getter of the AbstractRule.name attribute defined at extension ruleengineservices.
Integer	getPriority()	Generated method - Getter of the AbstractRule.priority attribute defined at extension ruleengineservices.
RuleGroupModel	getRuleGroup()	Generated method - Getter of the AbstractRule.ruleGroup attribute defined at extension ruleengineservices.
List<AbstractRulesModuleModel>	getRulesModules()	Generated method - Getter of the AbstractRule.rulesModules attribute defined at extension ruleengineservices.
Boolean	getStackable()	Deprecated, for removal: This API element is subject to removal in a future version. Since 6.7
Date	getStartDate()	Generated method - Getter of the AbstractRule.startDate attribute defined at extension ruleengineservices.
RuleStatus	getStatus()	Generated method - Getter of the AbstractRule.status attribute defined at extension ruleengineservices.
String	getUuid()	Generated method - Getter of the AbstractRule.uuid attribute defined at extension ruleengineservices.
Long	getVersion()	Generated method - Getter of the AbstractRule.version attribute defined at extension ruleengineservices.
void	setCode(String value)	Generated method - Initial setter of AbstractRule.code attribute defined at extension ruleengineservices.
void	setDescription(String value)	Generated method - Setter of AbstractRule.description attribute defined at extension ruleengineservices.
void	setDescription(String value, Locale loc)	Generated method - Setter of AbstractRule.description attribute defined at extension ruleengineservices.
void	setEndDate(Date value)	Generated method - Setter of AbstractRule.endDate attribute defined at extension ruleengineservices.
void	setEngineRules(Set<AbstractRuleEngineRuleModel> value)	Generated method - Setter of AbstractRule.engineRules attribute defined at extension ruleengineservices.
void	setMaxAllowedRuns(Integer value)	Generated method - Setter of AbstractRule.maxAllowedRuns attribute defined at extension ruleengineservices.
void	setMessageFired(String value)	Generated method - Setter of AbstractRule.messageFired attribute defined at extension ruleengineservices.
void	setMessageFired(String value, Locale loc)	Generated method - Setter of AbstractRule.messageFired attribute defined at extension ruleengineservices.
void	setName(String value)	Generated method - Setter of AbstractRule.name attribute defined at extension ruleengineservices.
void	setName(String value, Locale loc)	Generated method - Setter of AbstractRule.name attribute defined at extension ruleengineservices.
void	setPriority(Integer value)	Generated method - Setter of AbstractRule.priority attribute defined at extension ruleengineservices.
void	setRuleGroup(RuleGroupModel value)	Generated method - Setter of AbstractRule.ruleGroup attribute defined at extension ruleengineservices.
void	setRulesModules(List<AbstractRulesModuleModel> value)	Generated method - Setter of AbstractRule.rulesModules attribute defined at extension ruleengineservices.
void	setStackable(Boolean value)	Deprecated, for removal: This API element is subject to removal in a future version. Since 6.7
void	setStartDate(Date value)	Generated method - Setter of AbstractRule.startDate attribute defined at extension ruleengineservices.
void	setStatus(RuleStatus value)	Generated method - Setter of AbstractRule.status attribute defined at extension ruleengineservices.
void	setUuid(String value)	Generated method - Initial setter of AbstractRule.uuid attribute defined at extension ruleengineservices.
void	setVersion(Long value)	Generated method - Setter of AbstractRule.version attribute defined at extension ruleengineservices.

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

_RULEGROUP2ABSTRACTRULE

public static final String _RULEGROUP2ABSTRACTRULE

Generated relation code constant for relation RuleGroup2AbstractRule defining source attribute ruleGroup in extension ruleengineservices.

See Also:

• Constant Field Values

UUID

public static final String UUID

Generated constant - Attribute key of AbstractRule.uuid attribute defined at extension ruleengineservices.

See Also:

• Constant Field Values

CODE

public static final String CODE

Generated constant - Attribute key of AbstractRule.code attribute defined at extension ruleengineservices.

See Also:

• Constant Field Values

NAME

public static final String NAME

Generated constant - Attribute key of AbstractRule.name attribute defined at extension ruleengineservices.

See Also:

• Constant Field Values

DESCRIPTION

public static final String DESCRIPTION

Generated constant - Attribute key of AbstractRule.description attribute defined at extension ruleengineservices.

See Also:

• Constant Field Values

STARTDATE

public static final String STARTDATE

Generated constant - Attribute key of AbstractRule.startDate attribute defined at extension ruleengineservices.

See Also:

• Constant Field Values

ENDDATE

public static final String ENDDATE

Generated constant - Attribute key of AbstractRule.endDate attribute defined at extension ruleengineservices.

See Also:

• Constant Field Values

PRIORITY

public static final String PRIORITY

Generated constant - Attribute key of AbstractRule.priority attribute defined at extension ruleengineservices.

See Also:

• Constant Field Values

MAXALLOWEDRUNS

public static final String MAXALLOWEDRUNS

Generated constant - Attribute key of AbstractRule.maxAllowedRuns attribute defined at extension ruleengineservices.

See Also:

• Constant Field Values

STACKABLE

public static final String STACKABLE

Generated constant - Attribute key of AbstractRule.stackable attribute defined at extension ruleengineservices.

See Also:

• Constant Field Values

STATUS

public static final String STATUS

Generated constant - Attribute key of AbstractRule.status attribute defined at extension ruleengineservices.

See Also:

• Constant Field Values

VERSION

public static final String VERSION

Generated constant - Attribute key of AbstractRule.version attribute defined at extension ruleengineservices.

See Also:

• Constant Field Values

MESSAGEFIRED

public static final String MESSAGEFIRED

Generated constant - Attribute key of AbstractRule.messageFired attribute defined at extension ruleengineservices.

See Also:

• Constant Field Values

RULESMODULES

public static final String RULESMODULES

Generated constant - Attribute key of AbstractRule.rulesModules attribute defined at extension ruleengineservices.

See Also:

• Constant Field Values

RULEGROUP

public static final String RULEGROUP

Generated constant - Attribute key of AbstractRule.ruleGroup attribute defined at extension ruleengineservices.

See Also:

• Constant Field Values

ENGINERULES

public static final String ENGINERULES

Generated constant - Attribute key of AbstractRule.engineRules attribute defined at extension ruleengineservices.

See Also:

• Constant Field Values

Constructor Details

AbstractRuleModel

public AbstractRuleModel()

Generated constructor - Default constructor for generic creation.

AbstractRuleModel

public AbstractRuleModel(ItemModelContext ctx)

Generated constructor - Default constructor for creation with existing context

Parameters:

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

AbstractRuleModel

@Deprecated(since="4.1.1",
            forRemoval=true)
public AbstractRuleModel(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 AbstractRule at extension ruleengineservices

AbstractRuleModel

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

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 AbstractRule at extension ruleengineservices

_owner - initial attribute declared by type Item at extension core

_uuid - initial attribute declared by type AbstractRule at extension ruleengineservices

Method Details

getCode

@Accessor(qualifier="code",
          type=GETTER)
public String getCode()

Generated method - Getter of the AbstractRule.code attribute defined at extension ruleengineservices.

Returns:

the code - Rule code that defines the rule uniquely, cannot be changed after the rule is created

getDescription

@Accessor(qualifier="description",
          type=GETTER)
public String getDescription()

Generated method - Getter of the AbstractRule.description attribute defined at extension ruleengineservices.

Returns:

the description - Rule description

getDescription

@Accessor(qualifier="description",
          type=GETTER)
public String getDescription(Locale loc)

Generated method - Getter of the AbstractRule.description attribute defined at extension ruleengineservices.

Parameters:

loc - the value localization key

Returns:

the description - Rule description

Throws:

IllegalArgumentException - if localization key cannot be mapped to data language

getEndDate

@Accessor(qualifier="endDate",
          type=GETTER)
public Date getEndDate()

Generated method - Getter of the AbstractRule.endDate attribute defined at extension ruleengineservices.

Returns:

the endDate - Date on which this promotion stops being available, if not set the promotion will not be available.

getEngineRules

@Accessor(qualifier="engineRules",
          type=GETTER)
public Set<AbstractRuleEngineRuleModel> getEngineRules()

Generated method - Getter of the AbstractRule.engineRules attribute defined at extension ruleengineservices. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.

Returns:

the engineRules

getMaxAllowedRuns

@Accessor(qualifier="maxAllowedRuns",
          type=GETTER)
public Integer getMaxAllowedRuns()

Generated method - Getter of the AbstractRule.maxAllowedRuns attribute defined at extension ruleengineservices.

Returns:

the maxAllowedRuns - Number of times rule can be applied

getMessageFired

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

Generated method - Getter of the AbstractRule.messageFired attribute defined at extension ruleengineservices.

Returns:

the messageFired - Message for fired rule.

getMessageFired

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

Generated method - Getter of the AbstractRule.messageFired attribute defined at extension ruleengineservices.

Parameters:

loc - the value localization key

Returns:

the messageFired - Message for fired rule.

Throws:

IllegalArgumentException - if localization key cannot be mapped to data language

getName

@Accessor(qualifier="name",
          type=GETTER)
public String getName()

Generated method - Getter of the AbstractRule.name attribute defined at extension ruleengineservices.

Returns:

the name - Rule name

getName

@Accessor(qualifier="name",
          type=GETTER)
public String getName(Locale loc)

Generated method - Getter of the AbstractRule.name attribute defined at extension ruleengineservices.

Parameters:

loc - the value localization key

Returns:

the name - Rule name

Throws:

IllegalArgumentException - if localization key cannot be mapped to data language

getPriority

@Accessor(qualifier="priority",
          type=GETTER)
public Integer getPriority()

Generated method - Getter of the AbstractRule.priority attribute defined at extension ruleengineservices.

Returns:

the priority - priority (higher priority gets applied first)

getRuleGroup

@Accessor(qualifier="ruleGroup",
          type=GETTER)
public RuleGroupModel getRuleGroup()

Generated method - Getter of the AbstractRule.ruleGroup attribute defined at extension ruleengineservices.

Returns:

the ruleGroup

getRulesModules

@Accessor(qualifier="rulesModules",
          type=GETTER)
public List<AbstractRulesModuleModel> getRulesModules()

Generated method - Getter of the AbstractRule.rulesModules attribute defined at extension ruleengineservices. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.

Returns:

the rulesModules - List of the current deployments.

getStackable

@Deprecated(since="ages",
            forRemoval=true)
@Accessor(qualifier="stackable",
          type=GETTER)
public Boolean getStackable()

Deprecated, for removal: This API element is subject to removal in a future version.

Since 6.7

Generated method - Getter of the AbstractRule.stackable attribute defined at extension ruleengineservices.

Returns:

the stackable - whether the rule is stackable

getStartDate

@Accessor(qualifier="startDate",
          type=GETTER)
public Date getStartDate()

Generated method - Getter of the AbstractRule.startDate attribute defined at extension ruleengineservices.

Returns:

the startDate - Date on which this promotion becomes available, if not set the promotion will not be available.

getStatus

@Accessor(qualifier="status",
          type=GETTER)
public RuleStatus getStatus()

Generated method - Getter of the AbstractRule.status attribute defined at extension ruleengineservices.

Returns:

the status - Status of a rule

getUuid

@Accessor(qualifier="uuid",
          type=GETTER)
public String getUuid()

Generated method - Getter of the AbstractRule.uuid attribute defined at extension ruleengineservices.

Returns:

the uuid - Rule uuid that defines the rule uniquely, cannot be changed after the rule is created

getVersion

@Accessor(qualifier="version",
          type=GETTER)
public Long getVersion()

Generated method - Getter of the AbstractRule.version attribute defined at extension ruleengineservices.

Returns:

the version - rule version

setCode

@Accessor(qualifier="code",
          type=SETTER)
public void setCode(String value)

Generated method - Initial setter of AbstractRule.code attribute defined at extension ruleengineservices. Can only be used at creation of model - before first save.

Parameters:

value - the code - Rule code that defines the rule uniquely, cannot be changed after the rule is created

setDescription

@Accessor(qualifier="description",
          type=SETTER)
public void setDescription(String value)

Generated method - Setter of AbstractRule.description attribute defined at extension ruleengineservices.

Parameters:

value - the description - Rule description

setDescription

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

Generated method - Setter of AbstractRule.description attribute defined at extension ruleengineservices.

Parameters:

value - the description - Rule description

loc - the value localization key

Throws:

IllegalArgumentException - if localization key cannot be mapped to data language

setEndDate

@Accessor(qualifier="endDate",
          type=SETTER)
public void setEndDate(Date value)

Generated method - Setter of AbstractRule.endDate attribute defined at extension ruleengineservices.

Parameters:

value - the endDate - Date on which this promotion stops being available, if not set the promotion will not be available.

setEngineRules

@Accessor(qualifier="engineRules",
          type=SETTER)
public void setEngineRules(Set<AbstractRuleEngineRuleModel> value)

Generated method - Setter of AbstractRule.engineRules attribute defined at extension ruleengineservices.

Parameters:

value - the engineRules

setMaxAllowedRuns

@Accessor(qualifier="maxAllowedRuns",
          type=SETTER)
public void setMaxAllowedRuns(Integer value)

Generated method - Setter of AbstractRule.maxAllowedRuns attribute defined at extension ruleengineservices.

Parameters:

value - the maxAllowedRuns - Number of times rule can be applied

setMessageFired

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

Generated method - Setter of AbstractRule.messageFired attribute defined at extension ruleengineservices.

Parameters:

value - the messageFired - Message for fired rule.

setMessageFired

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

Generated method - Setter of AbstractRule.messageFired attribute defined at extension ruleengineservices.

Parameters:

value - the messageFired - Message for fired rule.

loc - the value localization key

Throws:

IllegalArgumentException - if localization key cannot be mapped to data language

setName

@Accessor(qualifier="name",
          type=SETTER)
public void setName(String value)

Generated method - Setter of AbstractRule.name attribute defined at extension ruleengineservices.

Parameters:

value - the name - Rule name

setName

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

Generated method - Setter of AbstractRule.name attribute defined at extension ruleengineservices.

Parameters:

value - the name - Rule name

loc - the value localization key

Throws:

IllegalArgumentException - if localization key cannot be mapped to data language

setPriority

@Accessor(qualifier="priority",
          type=SETTER)
public void setPriority(Integer value)

Generated method - Setter of AbstractRule.priority attribute defined at extension ruleengineservices.

Parameters:

value - the priority - priority (higher priority gets applied first)

setRuleGroup

@Accessor(qualifier="ruleGroup",
          type=SETTER)
public void setRuleGroup(RuleGroupModel value)

Generated method - Setter of AbstractRule.ruleGroup attribute defined at extension ruleengineservices.

Parameters:

value - the ruleGroup

setRulesModules

@Accessor(qualifier="rulesModules",
          type=SETTER)
public void setRulesModules(List<AbstractRulesModuleModel> value)

Generated method - Setter of AbstractRule.rulesModules attribute defined at extension ruleengineservices.

Parameters:

value - the rulesModules - List of the current deployments.

setStackable

@Deprecated(since="ages",
            forRemoval=true)
@Accessor(qualifier="stackable",
          type=SETTER)
public void setStackable(Boolean value)

Deprecated, for removal: This API element is subject to removal in a future version.

Since 6.7

Generated method - Setter of AbstractRule.stackable attribute defined at extension ruleengineservices.

Parameters:

value - the stackable - whether the rule is stackable

setStartDate

@Accessor(qualifier="startDate",
          type=SETTER)
public void setStartDate(Date value)

Generated method - Setter of AbstractRule.startDate attribute defined at extension ruleengineservices.

Parameters:

value - the startDate - Date on which this promotion becomes available, if not set the promotion will not be available.

setStatus

@Accessor(qualifier="status",
          type=SETTER)
public void setStatus(RuleStatus value)

Generated method - Setter of AbstractRule.status attribute defined at extension ruleengineservices.

Parameters:

value - the status - Status of a rule

setUuid

@Accessor(qualifier="uuid",
          type=SETTER)
public void setUuid(String value)

Generated method - Initial setter of AbstractRule.uuid attribute defined at extension ruleengineservices. Can only be used at creation of model - before first save.

Parameters:

value - the uuid - Rule uuid that defines the rule uniquely, cannot be changed after the rule is created

setVersion

@Accessor(qualifier="version",
          type=SETTER)
public void setVersion(Long value)

Generated method - Setter of AbstractRule.version attribute defined at extension ruleengineservices.

Parameters:

value - the version - rule version