org.kuali.rice.krms.api.repository.rule

Class RuleDefinition

java.lang.Object

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

org.kuali.rice.krms.api.repository.rule.RuleDefinition

All Implemented Interfaces:

Serializable, Inactivatable, Identifiable, Versioned, ModelObjectBasic, ModelObjectComplete, RuleDefinitionContract

public final class RuleDefinition
extends AbstractDataTransferObject
implements RuleDefinitionContract

Concrete model object implementation of KRMS Repository Rule immutable. Instances of Rule can be (un)marshalled to and from XML.

See Also:

RuleDefinitionContract, Rule, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RuleDefinition.Builder This builder is used to construct instances of KRMS Repository Rule.
static class	RuleDefinition.Cache
static class	RuleDefinition.Constants Defines some internal constants used on this class.
static class	RuleDefinition.Elements A private class which exposes constants which define the XML element names to use when this object is marshalled to XML.

Method Summary

Methods

Modifier and Type	Method and Description
List<ActionDefinition>	getActions() This method returns a list of Actions associated with the Rule.
Map<String,String>	getAttributes() Returns the internal representation of the set of attributes associated with the Action.
String	getDescription() This is the description of the Rule
String	getId() The unique identifier for an object.
String	getName() This is the name of the Rule
String	getNamespace() This is the namespace of the Rule
String	getPropId() This method returns the ID of the Proposition associated with the rule.
PropositionDefinition	getProposition() This method returns the Proposition associated with the rule.
String	getTypeId() This is the KrmsType of the Rule
Long	getVersionNumber() Returns the version number for this object.
boolean	isActive() The active indicator for an object.

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: RuleDefinitionContract

This is the name of the Rule

name - the name of the Rule

Specified by:

getName in interface RuleDefinitionContract

Returns:

the name of the Rule

getDescription

public String getDescription()

Description copied from interface: RuleDefinitionContract

This is the description of the Rule

description - the description of the Rule

Specified by:

getDescription in interface RuleDefinitionContract

Returns:

the description of the Rule

getNamespace

public String getNamespace()

Description copied from interface: RuleDefinitionContract

This is the namespace of the Rule

The namespace of the Rule

Specified by:

getNamespace in interface RuleDefinitionContract

Returns:

the namespace of the Rule

getTypeId

public String getTypeId()

Description copied from interface: RuleDefinitionContract

This is the KrmsType of the Rule

Specified by:

getTypeId in interface RuleDefinitionContract

Returns:

id for KRMS type related of the Rule

getPropId

public String getPropId()

Description copied from interface: RuleDefinitionContract

This method returns the ID of the Proposition associated with the rule.

Each Rule has exactly one Proposition associated with it.

Specified by:

getPropId in interface RuleDefinitionContract

Returns:

the id of the Proposition associated with the Rule

isActive

public boolean isActive()

Description copied from interface: Inactivatable

The active indicator for an object.

Specified by:

isActive in interface Inactivatable

Returns:

true if active false if not.

getProposition

public PropositionDefinition getProposition()

Description copied from interface: RuleDefinitionContract

This method returns the Proposition associated with the rule.

Each Rule has exactly one Proposition associated with it.

Specified by:

getProposition in interface RuleDefinitionContract

Returns:

an immutable representation of the Proposition associated with the Rule

getActions

public List<ActionDefinition> getActions()

Description copied from interface: RuleDefinitionContract

This method returns a list of Actions associated with the Rule.

A Rule may have zero or more Actions associated with it.

Specified by:

getActions in interface RuleDefinitionContract

Returns:

An ordered list of Actions associated with a Rule.

getAttributes

public Map<String,String> getAttributes()

Returns the internal representation of the set of attributes associated with the Action. The attributes are represented as name/value pairs.

Specified by:

getAttributes in interface RuleDefinitionContract

Returns:

internal representation of the set of ActionAttribute objects.

getVersionNumber

public Long getVersionNumber()

Description copied from interface: Versioned

Returns the version number for this object. In general, this value should only be null if the object has not yet been stored to a persistent data store. This version number is generally used for the purposes of optimistic locking.

Specified by:

getVersionNumber in interface Versioned

Returns:

the version number, or null if one has not been assigned yet