org.kuali.rice.kew.api.rule

Class Rule

java.lang.Object

org.kuali.rice.core.api.mo.AbstractDataTransferObject

org.kuali.rice.kew.api.rule.Rule

All Implemented Interfaces:

Serializable, Identifiable, ModelObjectBasic, ModelObjectComplete, RuleContract

public final class Rule
extends AbstractDataTransferObject
implements RuleContract

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Rule.Builder A builder which can be used to construct Rule instances.
static class	Rule.Cache

Method Summary

Methods

Modifier and Type	Method and Description
String	getDescription() The description of the rule.
String	getDocTypeName() The documentTypeName of the rule.
org.joda.time.DateTime	getFromDate() The ending date of the rule.
String	getId() The unique identifier for an object.
String	getName() Unique Name for the Rule.
String	getPreviousRuleId() Unique id for the previous version of this Rule.
RuleExpression	getRuleExpressionDef() Expression for rule to evaluate.
Map<String,String>	getRuleExtensionMap()
List<RuleExtension>	getRuleExtensions() List of rule extensions associated with the Rule
List<RuleResponsibility>	getRuleResponsibilities() List of rule responsibilities associated with the Rule
RuleTemplate	getRuleTemplate() Unique Id for Template of Rule.
String	getRuleTemplateName() Template Name of the Rule.
org.joda.time.DateTime	getToDate() The ending date of the rule.
boolean	isActive() The active indicator for the rule.
boolean	isForceAction() Shows if rule will force its action.

Methods inherited from class org.kuali.rice.core.api.mo.AbstractDataTransferObject

afterUnmarshal, beforeUnmarshal, equals, equalsExcludeFields, getDefaultHashCodeEqualsExcludeFields, hashCode, hashCodeExcludeFields, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getId

public String getId()

Description copied from interface: Identifiable

The unique identifier for an object. This can be null.

Specified by:

getId in interface Identifiable

Returns:

the id

getName

public String getName()

Description copied from interface: RuleContract

Unique Name for the Rule.

This is the unique name of the Rule

Specified by:

getName in interface RuleContract

Returns:

name

getRuleTemplate

public RuleTemplate getRuleTemplate()

Description copied from interface: RuleContract

Unique Id for Template of Rule.

This is the unique Id of the rule template of the rule

Specified by:

getRuleTemplate in interface RuleContract

Returns:

ruleTemplateId

isActive

public boolean isActive()

Description copied from interface: RuleContract

The active indicator for the rule.

Specified by:

isActive in interface RuleContract

Returns:

true if active false if not.

getDescription

public String getDescription()

Description copied from interface: RuleContract

The description of the rule.

Specified by:

getDescription in interface RuleContract

Returns:

description

getPreviousRuleId

public String getPreviousRuleId()

Description copied from interface: RuleContract

Unique id for the previous version of this Rule.

This is the unique id value of the previous version of this Rule.

Specified by:

getPreviousRuleId in interface RuleContract

Returns:

previousVersionId

getDocTypeName

public String getDocTypeName()

Description copied from interface: RuleContract

The documentTypeName of the rule.

Specified by:

getDocTypeName in interface RuleContract

Returns:

documentTypeName

getFromDate

public org.joda.time.DateTime getFromDate()

Description copied from interface: RuleContract

The ending date of the rule.

This is the date from which the rule stops being be used

Specified by:

getFromDate in interface RuleContract

Returns:

fromDate

getToDate

public org.joda.time.DateTime getToDate()

Description copied from interface: RuleContract

The ending date of the rule.

This is the date from which the rule starts to be used

Specified by:

getToDate in interface RuleContract

Returns:

toDate

isForceAction

public boolean isForceAction()

Description copied from interface: RuleContract

Shows if rule will force its action.

Specified by:

isForceAction in interface RuleContract

Returns:

boolean value representing if action is forced

getRuleResponsibilities

public List<RuleResponsibility> getRuleResponsibilities()

Description copied from interface: RuleContract

List of rule responsibilities associated with the Rule

Specified by:

getRuleResponsibilities in interface RuleContract

Returns:

ruleResponsibilities

getRuleExtensions

public List<RuleExtension> getRuleExtensions()

Description copied from interface: RuleContract

List of rule extensions associated with the Rule

Specified by:

getRuleExtensions in interface RuleContract

Returns:

ruleExtensions

getRuleExtensionMap

public Map<String,String> getRuleExtensionMap()

getRuleTemplateName

public String getRuleTemplateName()

Description copied from interface: RuleContract

Template Name of the Rule.

This is the name of the rule template for the rule

Specified by:

getRuleTemplateName in interface RuleContract

Returns:

ruleTemplateName

getRuleExpressionDef

public RuleExpression getRuleExpressionDef()

Description copied from interface: RuleContract

Expression for rule to evaluate.

This is expression definition of the rule

Specified by:

getRuleExpressionDef in interface RuleContract

Returns:

ruleExpressionDef