org.osid.rules.check

Interface CheckResult

All Superinterfaces:

Browsable, Extensible, OsidResult

public interface CheckResult
extends OsidResult

The results of an evaluation. A CheckResult is issued for every Check evaluated and is considered successful if hasFailed() is false. Checks not evaluated because the Check was not applicable due to the Instruction do not produce a CheckResult. Results for Checks evaluated as part of a dependent Agenda are included.

Method Summary

Methods

Modifier and Type	Method and Description
CheckResultRecord	getCheckResultRecord(Type checkResultRecordType) Gets the check result record corresponding to the given CheckResult record Type.
Instruction	getInstruction() Gets the instruction for this result.
Id	getInstructionId() Gets the instruction Id for this result.
DisplayText	getMessage() Gets a message which may be the cause of the failure, a warning message, or the weather.
boolean	hasFailed() Tests if the corresponding Check has failed.
boolean	isWarning() Tests if the informational message should be displayed as a warning.

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Method Detail

getInstructionId

Id getInstructionId()

Gets the instruction Id for this result.

Returns:

the instruction Id

Compliance:

mandatory - This method must be implemented.

getInstruction

Instruction getInstruction()
                           throws OperationFailedException

Gets the instruction for this result.

Returns:

the instruction

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

hasFailed

boolean hasFailed()

Tests if the corresponding Check has failed. Failed checks resulting in warnings should return false.

Returns:

true if this check failed, false otherwise

Compliance:

mandatory - This method must be implemented.

isWarning

boolean isWarning()

Tests if the informational message should be displayed as a warning.

Returns:

true if this check is a warning, false otherwise

Compliance:

mandatory - This method must be implemented.

getMessage

DisplayText getMessage()

Gets a message which may be the cause of the failure, a warning message, or the weather.

Returns:

a message

Compliance:

mandatory - This method must be implemented.

getCheckResultRecord

CheckResultRecord getCheckResultRecord(Type checkResultRecordType)
                                       throws OperationFailedException,
                                              PermissionDeniedException

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

Parameters:

checkResultRecordType - the type of check result record to retrieve

Returns:

the check result record

Throws:

NullArgumentException - checkresultRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(checkResultRecordType) is false

Compliance:

mandatory - This method must be implemented.