OSID - osid.rules.check.CheckResult Service Interface Definition

Interface	osid.rules.check.CheckResult
Implements	`osid.OsidResult`
Description	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	getInstructionId
Description	Gets the instruction `Id` for this result.
Return	`osid.id.Id`		the instruction `Id`
Compliance	`mandatory`		This method must be implemented.
Method	getInstruction
Description	Gets the instruction for this result.
Return	`osid.rules.check.Instruction`		the instruction
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	hasFailed
Description	Tests if the corresponding `Check` has failed. Failed checks resulting in warnings should return `false.`
Return	`boolean`		`true` if this check failed, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	isWarning
Description	Tests if the informational message should be displayed as a warning.
Return	`boolean`		`true` if this check is a warning, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getMessage
Description	Gets a message which may be the cause of the failure, a warning message, or the weather.
Return	`osid.locale.DisplayText`		a message
Compliance	`mandatory`		This method must be implemented.
Method	getCheckResultRecord
Description	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	`osid.type.Type`	`checkResultRecordType`	the type of check result record to retrieve
Return	`osid.rules.check.records.CheckResultRecord`		the check result record
Errors	NULL_ARGUMENT		`checkresultRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`hasRecordType(checkResultRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.