Interface Result

All Superinterfaces:

Browsable, Extensible, OsidResult

public interface Result
extends OsidResult

The Result is the output of a rule execution.

Method Summary

Modifier and Type	Method	Description
boolean	getBooleanValue()	Gets a boolean result from the rule evaluation.
ResultRecord	getResultRecord(Type resultRecordType)	Gets the result record corresponding to the given ResultRecord record Type.

Methods inherited from interface Browsable

getProperties, getPropertiesByRecordType

Modifier and Type	Method	Description
PropertyList	getProperties()	Gets a list of properties.
PropertyList	getPropertiesByRecordType(Type recordType)	Gets a list of properties corresponding to the specified record type.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type.

Method Details

getBooleanValue

boolean getBooleanValue()

Gets a boolean result from the rule evaluation. Based on the definition of the Rule, the result may be a simple boolean value or something more complex defined in the record type.

Returns:

true or false

Compliance:

mandatory - This method must be implemented.

getResultRecord

ResultRecord getResultRecord(Type resultRecordType)
                      throws OperationFailedException

Gets the result record corresponding to the given ResultRecord record Type. This method is used to retrieve an object implementing the requested record. The resultRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(resultRecordType) is true.

Parameters:

resultRecordType - the type of result record to retrieve

Returns:

the result record

Throws:

NullArgumentException - resultRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(resultRecordType) is false

Compliance:

mandatory - This method must be implemented.