public interface Rule extends OsidRule
A Rule
represents an entity that can be executed in a
rules engine.
Modifier and Type | Method and Description |
---|---|
RuleRecord |
getRuleRecord(Type ruleRecordType)
Gets the rule record corresponding to the given
Rule
record Type. |
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
isActive, isDisabled, isEnabled, isOperational
RuleRecord getRuleRecord(Type ruleRecordType) throws OperationFailedException
Rule
record Type.
This method is used to retrieve an object
implementing the requested record. The ruleRecordType
may be the Type
returned in getRecordTypes()
or any of its parents in a Type
hierarchy where
hasRecordType(ruleRecordType)
is true
.ruleRecordType
- the type of rule record to retrieveNullArgumentException
- ruleRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(ruleRecordType)
is false
mandatory
- This method must be implemented.