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

All Superinterfaces:

Identifiable, Inactivatable, Versioned

All Known Implementing Classes:

RuleDefinition, RuleDefinition.Builder

public interface RuleDefinitionContract
extends Identifiable, Inactivatable, Versioned

Defines the contract for a RuleDefinition

Author:

Kuali Rice Team (rice.collab@kuali.org)

See Also:

RuleDefinition, Rule

Method Summary

List<? extends ActionDefinitionContract>	getActions() This method returns a list of Actions associated with the Rule.
Map<String,String>	getAttributes() This method returns a Map of attributes associated with the Rule.
String	getDescription() This is the description of the Rule
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.
PropositionDefinitionContract	getProposition() This method returns the Proposition associated with the rule.
String	getTypeId() This is the KrmsType of the Rule

Methods inherited from interface org.kuali.rice.core.api.mo.common.Identifiable

getId

Methods inherited from interface org.kuali.rice.core.api.mo.common.active.Inactivatable

isActive

Methods inherited from interface org.kuali.rice.core.api.mo.common.Versioned

getVersionNumber

Method Detail

getName

String getName()

This is the name of the Rule

name - the name of the Rule

Returns:

the name of the Rule

getDescription

String getDescription()

This is the description of the Rule

description - the description of the Rule

Returns:

the description of the Rule

getNamespace

String getNamespace()

This is the namespace of the Rule

The namespace of the Rule

Returns:

the namespace of the Rule

getTypeId

String getTypeId()

This is the KrmsType of the Rule

Returns:

id for KRMS type related of the Rule

getPropId

String getPropId()

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

Each Rule has exactly one Proposition associated with it.

Returns:

the id of the Proposition associated with the Rule

getProposition

PropositionDefinitionContract getProposition()

This method returns the Proposition associated with the rule.

Each Rule has exactly one Proposition associated with it.

Returns:

an immutable representation of the Proposition associated with the Rule

getActions

List<? extends ActionDefinitionContract> getActions()

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

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

Returns:

An ordered list of Actions associated with a Rule.

getAttributes

Map<String,String> getAttributes()

This method returns a Map of attributes associated with the Rule. The attributes are represented as name/value pairs.

Returns:

a Map of RuleAttribute objects.