Package de.hybris.platform.ruleengine.model

Class AbstractRuleEngineRuleModel

java.lang.Object

de.hybris.platform.servicelayer.model.AbstractItemModel

de.hybris.platform.core.model.ItemModel

de.hybris.platform.ruleengine.model.AbstractRuleEngineRuleModel

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

DroolsRuleModel

public class AbstractRuleEngineRuleModel
extends ItemModel

Generated model class for type AbstractRuleEngineRule first defined at extension ruleengine.

AbstractRuleEngineRule is an abstraction for a rule being executed in the rule engine.

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	_SOURCERULE2DROOLSRULE	Generated relation code constant for relation SourceRule2DroolsRule defining source attribute sourceRule in extension ruleengineservices.
static final String	_TYPECODE	Generated model type code constant.
static final String	ACTIVE	Generated constant - Attribute key of AbstractRuleEngineRule.active attribute defined at extension ruleengine.
static final String	CHECKSUM	Generated constant - Attribute key of AbstractRuleEngineRule.checksum attribute defined at extension ruleengine.
static final String	CODE	Generated constant - Attribute key of AbstractRuleEngineRule.code attribute defined at extension ruleengine.
static final String	CURRENTVERSION	Generated constant - Attribute key of AbstractRuleEngineRule.currentVersion attribute defined at extension ruleengine.
static final String	MAXALLOWEDRUNS	Generated constant - Attribute key of AbstractRuleEngineRule.maxAllowedRuns attribute defined at extension ruleengineservices.
static final String	MESSAGEFIRED	Generated constant - Attribute key of AbstractRuleEngineRule.messageFired attribute defined at extension ruleengineservices.
static final String	PROMOTION	Generated constant - Attribute key of AbstractRuleEngineRule.promotion attribute defined at extension promotionengineservices.
static final String	RULECONTENT	Generated constant - Attribute key of AbstractRuleEngineRule.ruleContent attribute defined at extension ruleengine.
static final String	RULEGROUPCODE	Generated constant - Attribute key of AbstractRuleEngineRule.ruleGroupCode attribute defined at extension ruleengineservices.
static final String	RULEPARAMETERS	Generated constant - Attribute key of AbstractRuleEngineRule.ruleParameters attribute defined at extension ruleengineservices.
static final String	RULETYPE	Generated constant - Attribute key of AbstractRuleEngineRule.ruleType attribute defined at extension ruleengine.
static final String	SOURCERULE	Generated constant - Attribute key of AbstractRuleEngineRule.sourceRule attribute defined at extension ruleengineservices.
static final String	UUID	Generated constant - Attribute key of AbstractRuleEngineRule.uuid attribute defined at extension ruleengine.
static final String	VERSION	Generated constant - Attribute key of AbstractRuleEngineRule.version attribute defined at extension ruleengine.

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
AbstractRuleEngineRuleModel()	Generated constructor - Default constructor for generic creation.
AbstractRuleEngineRuleModel(de.hybris.platform.servicelayer.model.ItemModelContext ctx)	Generated constructor - Default constructor for creation with existing context
AbstractRuleEngineRuleModel(String _code, ItemModel _owner, RuleType _ruleType, String _uuid, Long _version)	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
AbstractRuleEngineRuleModel(String _code, RuleType _ruleType, String _uuid, Long _version)	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
Boolean	getActive()	Generated method - Getter of the AbstractRuleEngineRule.active attribute defined at extension ruleengine.
String	getChecksum()	Generated method - Getter of the AbstractRuleEngineRule.checksum attribute defined at extension ruleengine.
String	getCode()	Generated method - Getter of the AbstractRuleEngineRule.code attribute defined at extension ruleengine.
Boolean	getCurrentVersion()	Generated method - Getter of the AbstractRuleEngineRule.currentVersion attribute defined at extension ruleengine.
Integer	getMaxAllowedRuns()	Generated method - Getter of the AbstractRuleEngineRule.maxAllowedRuns attribute defined at extension ruleengineservices.
String	getMessageFired()	Generated method - Getter of the AbstractRuleEngineRule.messageFired attribute defined at extension ruleengineservices.
String	getMessageFired(Locale loc)	Generated method - Getter of the AbstractRuleEngineRule.messageFired attribute defined at extension ruleengineservices.
RuleBasedPromotionModel	getPromotion()	Generated method - Getter of the AbstractRuleEngineRule.promotion attribute defined at extension promotionengineservices.
String	getRuleContent()	Generated method - Getter of the AbstractRuleEngineRule.ruleContent attribute defined at extension ruleengine.
String	getRuleGroupCode()	Generated method - Getter of the AbstractRuleEngineRule.ruleGroupCode attribute defined at extension ruleengineservices.
String	getRuleParameters()	Generated method - Getter of the AbstractRuleEngineRule.ruleParameters attribute defined at extension ruleengineservices.
RuleType	getRuleType()	Generated method - Getter of the AbstractRuleEngineRule.ruleType attribute defined at extension ruleengine.
AbstractRuleModel	getSourceRule()	Generated method - Getter of the AbstractRuleEngineRule.sourceRule attribute defined at extension ruleengineservices.
String	getUuid()	Generated method - Getter of the AbstractRuleEngineRule.uuid attribute defined at extension ruleengine.
Long	getVersion()	Generated method - Getter of the AbstractRuleEngineRule.version attribute defined at extension ruleengine.
void	setActive(Boolean value)	Generated method - Setter of AbstractRuleEngineRule.active attribute defined at extension ruleengine.
void	setChecksum(String value)	Generated method - Setter of AbstractRuleEngineRule.checksum attribute defined at extension ruleengine.
void	setCode(String value)	Generated method - Initial setter of AbstractRuleEngineRule.code attribute defined at extension ruleengine.
void	setCurrentVersion(Boolean value)	Generated method - Setter of AbstractRuleEngineRule.currentVersion attribute defined at extension ruleengine.
void	setMaxAllowedRuns(Integer value)	Generated method - Setter of AbstractRuleEngineRule.maxAllowedRuns attribute defined at extension ruleengineservices.
void	setMessageFired(String value)	Generated method - Setter of AbstractRuleEngineRule.messageFired attribute defined at extension ruleengineservices.
void	setMessageFired(String value, Locale loc)	Generated method - Setter of AbstractRuleEngineRule.messageFired attribute defined at extension ruleengineservices.
void	setPromotion(RuleBasedPromotionModel value)	Generated method - Setter of AbstractRuleEngineRule.promotion attribute defined at extension promotionengineservices.
void	setRuleContent(String value)	Generated method - Setter of AbstractRuleEngineRule.ruleContent attribute defined at extension ruleengine.
void	setRuleGroupCode(String value)	Generated method - Setter of AbstractRuleEngineRule.ruleGroupCode attribute defined at extension ruleengineservices.
void	setRuleParameters(String value)	Generated method - Setter of AbstractRuleEngineRule.ruleParameters attribute defined at extension ruleengineservices.
void	setRuleType(RuleType value)	Generated method - Setter of AbstractRuleEngineRule.ruleType attribute defined at extension ruleengine.
void	setSourceRule(AbstractRuleModel value)	Generated method - Setter of AbstractRuleEngineRule.sourceRule attribute defined at extension ruleengineservices.
void	setUuid(String value)	Generated method - Setter of AbstractRuleEngineRule.uuid attribute defined at extension ruleengine.
void	setVersion(Long value)	Generated method - Setter of AbstractRuleEngineRule.version attribute defined at extension ruleengine.

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

_SOURCERULE2DROOLSRULE

public static final String _SOURCERULE2DROOLSRULE

Generated relation code constant for relation SourceRule2DroolsRule defining source attribute sourceRule in extension ruleengineservices.

See Also:

• Constant Field Values

UUID

public static final String UUID

Generated constant - Attribute key of AbstractRuleEngineRule.uuid attribute defined at extension ruleengine.

See Also:

• Constant Field Values

CODE

public static final String CODE

Generated constant - Attribute key of AbstractRuleEngineRule.code attribute defined at extension ruleengine.

See Also:

• Constant Field Values

ACTIVE

public static final String ACTIVE

Generated constant - Attribute key of AbstractRuleEngineRule.active attribute defined at extension ruleengine.

See Also:

• Constant Field Values

RULECONTENT

public static final String RULECONTENT

Generated constant - Attribute key of AbstractRuleEngineRule.ruleContent attribute defined at extension ruleengine.

See Also:

• Constant Field Values

RULETYPE

public static final String RULETYPE

Generated constant - Attribute key of AbstractRuleEngineRule.ruleType attribute defined at extension ruleengine.

See Also:

• Constant Field Values

CHECKSUM

public static final String CHECKSUM

Generated constant - Attribute key of AbstractRuleEngineRule.checksum attribute defined at extension ruleengine.

See Also:

• Constant Field Values

CURRENTVERSION

public static final String CURRENTVERSION

Generated constant - Attribute key of AbstractRuleEngineRule.currentVersion attribute defined at extension ruleengine.

See Also:

• Constant Field Values

VERSION

public static final String VERSION

Generated constant - Attribute key of AbstractRuleEngineRule.version attribute defined at extension ruleengine.

See Also:

• Constant Field Values

RULEPARAMETERS

public static final String RULEPARAMETERS

Generated constant - Attribute key of AbstractRuleEngineRule.ruleParameters attribute defined at extension ruleengineservices.

See Also:

• Constant Field Values

MAXALLOWEDRUNS

public static final String MAXALLOWEDRUNS

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

See Also:

• Constant Field Values

RULEGROUPCODE

public static final String RULEGROUPCODE

Generated constant - Attribute key of AbstractRuleEngineRule.ruleGroupCode attribute defined at extension ruleengineservices.

See Also:

• Constant Field Values

MESSAGEFIRED

public static final String MESSAGEFIRED

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

See Also:

• Constant Field Values

SOURCERULE

public static final String SOURCERULE

Generated constant - Attribute key of AbstractRuleEngineRule.sourceRule attribute defined at extension ruleengineservices.

See Also:

• Constant Field Values

PROMOTION

public static final String PROMOTION

Generated constant - Attribute key of AbstractRuleEngineRule.promotion attribute defined at extension promotionengineservices.

See Also:

• Constant Field Values

Constructor Details

AbstractRuleEngineRuleModel

public AbstractRuleEngineRuleModel()

Generated constructor - Default constructor for generic creation.

AbstractRuleEngineRuleModel

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

AbstractRuleEngineRuleModel

@Deprecated(since="4.1.1",
            forRemoval=true)
public AbstractRuleEngineRuleModel(String _code,
 RuleType _ruleType,
 String _uuid,
 Long _version)

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 AbstractRuleEngineRule at extension ruleengine

_ruleType - initial attribute declared by type AbstractRuleEngineRule at extension ruleengine

_uuid - initial attribute declared by type AbstractRuleEngineRule at extension ruleengine

_version - initial attribute declared by type AbstractRuleEngineRule at extension ruleengine

AbstractRuleEngineRuleModel

@Deprecated(since="4.1.1",
            forRemoval=true)
public AbstractRuleEngineRuleModel(String _code,
 ItemModel _owner,
 RuleType _ruleType,
 String _uuid,
 Long _version)

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 AbstractRuleEngineRule at extension ruleengine

_owner - initial attribute declared by type Item at extension core

_ruleType - initial attribute declared by type AbstractRuleEngineRule at extension ruleengine

_uuid - initial attribute declared by type AbstractRuleEngineRule at extension ruleengine

_version - initial attribute declared by type AbstractRuleEngineRule at extension ruleengine

Method Details

getActive

@Accessor(qualifier="active",
          type=GETTER)
public Boolean getActive()

Generated method - Getter of the AbstractRuleEngineRule.active attribute defined at extension ruleengine.

Returns:

the active - Is rule active

getChecksum

@Accessor(qualifier="checksum",
          type=GETTER)
public String getChecksum()

Generated method - Getter of the AbstractRuleEngineRule.checksum attribute defined at extension ruleengine.

Returns:

the checksum

getCode

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

Generated method - Getter of the AbstractRuleEngineRule.code attribute defined at extension ruleengine.

Returns:

the code - unique rule code

getCurrentVersion

@Accessor(qualifier="currentVersion",
          type=GETTER)
public Boolean getCurrentVersion()

Generated method - Getter of the AbstractRuleEngineRule.currentVersion attribute defined at extension ruleengine.

Returns:

the currentVersion - Is this rule current?

getMaxAllowedRuns

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

Generated method - Getter of the AbstractRuleEngineRule.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 AbstractRuleEngineRule.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 AbstractRuleEngineRule.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

getPromotion

@Accessor(qualifier="promotion",
          type=GETTER)
public RuleBasedPromotionModel getPromotion()

Generated method - Getter of the AbstractRuleEngineRule.promotion attribute defined at extension promotionengineservices.

Returns:

the promotion - Promotion created for this rule.

getRuleContent

@Accessor(qualifier="ruleContent",
          type=GETTER)
public String getRuleContent()

Generated method - Getter of the AbstractRuleEngineRule.ruleContent attribute defined at extension ruleengine.

Returns:

the ruleContent - contains rule syntax

getRuleGroupCode

@Accessor(qualifier="ruleGroupCode",
          type=GETTER)
public String getRuleGroupCode()

Generated method - Getter of the AbstractRuleEngineRule.ruleGroupCode attribute defined at extension ruleengineservices.

Returns:

the ruleGroupCode - The code of the rule group that this rule is part of (derived from the AbstractRule).

getRuleParameters

@Accessor(qualifier="ruleParameters",
          type=GETTER)
public String getRuleParameters()

Generated method - Getter of the AbstractRuleEngineRule.ruleParameters attribute defined at extension ruleengineservices.

Returns:

the ruleParameters

getRuleType

@Accessor(qualifier="ruleType",
          type=GETTER)
public RuleType getRuleType()

Generated method - Getter of the AbstractRuleEngineRule.ruleType attribute defined at extension ruleengine.

Returns:

the ruleType - Rule type

getSourceRule

@Accessor(qualifier="sourceRule",
          type=GETTER)
public AbstractRuleModel getSourceRule()

Generated method - Getter of the AbstractRuleEngineRule.sourceRule attribute defined at extension ruleengineservices.

Returns:

the sourceRule

getUuid

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

Generated method - Getter of the AbstractRuleEngineRule.uuid attribute defined at extension ruleengine.

Returns:

the uuid

getVersion

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

Generated method - Getter of the AbstractRuleEngineRule.version attribute defined at extension ruleengine.

Returns:

the version - unique rule version

setActive

@Accessor(qualifier="active",
          type=SETTER)
public void setActive(Boolean value)

Generated method - Setter of AbstractRuleEngineRule.active attribute defined at extension ruleengine.

Parameters:

value - the active - Is rule active

setChecksum

@Accessor(qualifier="checksum",
          type=SETTER)
public void setChecksum(String value)

Generated method - Setter of AbstractRuleEngineRule.checksum attribute defined at extension ruleengine.

Parameters:

value - the checksum

setCode

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

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

Parameters:

value - the code - unique rule code

setCurrentVersion

@Accessor(qualifier="currentVersion",
          type=SETTER)
public void setCurrentVersion(Boolean value)

Generated method - Setter of AbstractRuleEngineRule.currentVersion attribute defined at extension ruleengine.

Parameters:

value - the currentVersion - Is this rule current?

setMaxAllowedRuns

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

Generated method - Setter of AbstractRuleEngineRule.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 AbstractRuleEngineRule.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 AbstractRuleEngineRule.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

setPromotion

@Accessor(qualifier="promotion",
          type=SETTER)
public void setPromotion(RuleBasedPromotionModel value)

Generated method - Setter of AbstractRuleEngineRule.promotion attribute defined at extension promotionengineservices.

Parameters:

value - the promotion - Promotion created for this rule.

setRuleContent

@Accessor(qualifier="ruleContent",
          type=SETTER)
public void setRuleContent(String value)

Generated method - Setter of AbstractRuleEngineRule.ruleContent attribute defined at extension ruleengine.

Parameters:

value - the ruleContent - contains rule syntax

setRuleGroupCode

@Accessor(qualifier="ruleGroupCode",
          type=SETTER)
public void setRuleGroupCode(String value)

Generated method - Setter of AbstractRuleEngineRule.ruleGroupCode attribute defined at extension ruleengineservices.

Parameters:

value - the ruleGroupCode - The code of the rule group that this rule is part of (derived from the AbstractRule).

setRuleParameters

@Accessor(qualifier="ruleParameters",
          type=SETTER)
public void setRuleParameters(String value)

Generated method - Setter of AbstractRuleEngineRule.ruleParameters attribute defined at extension ruleengineservices.

Parameters:

value - the ruleParameters

setRuleType

@Accessor(qualifier="ruleType",
          type=SETTER)
public void setRuleType(RuleType value)

Generated method - Setter of AbstractRuleEngineRule.ruleType attribute defined at extension ruleengine.

Parameters:

value - the ruleType - Rule type

setSourceRule

@Accessor(qualifier="sourceRule",
          type=SETTER)
public void setSourceRule(AbstractRuleModel value)

Generated method - Setter of AbstractRuleEngineRule.sourceRule attribute defined at extension ruleengineservices.

Parameters:

value - the sourceRule

setUuid

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

Generated method - Setter of AbstractRuleEngineRule.uuid attribute defined at extension ruleengine.

Parameters:

value - the uuid

setVersion

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

Generated method - Setter of AbstractRuleEngineRule.version attribute defined at extension ruleengine.

Parameters:

value - the version - unique rule version