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

Interface	osid.rules.check.Instruction
Implements	`osid.OsidRelationship`
Implements	`osid.OsidRuleApplicator`
Used By	`osid.rules.check.InstructionAdminSession`
	`osid.rules.check.InstructionList`
	`osid.rules.check.InstructionLookupSession`
Description	A `Instruction` appliies a `Check` to an `Agenda`.
Method	getAgendaId
Description	Gets the `Id` of the agenda.
Return	`osid.id.Id`		the agenda `Id`
Compliance	`mandatory`		This method must be implemented.
Method	getAgenda
Description	Gets the agenda.
Return	`osid.rules.check.Agenda`		the agenda
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getCheckId
Description	Gets the `Id` of the check.
Return	`osid.id.Id`		the check `Id`
Compliance	`mandatory`		This method must be implemented.
Method	getCheck
Description	Gets the check.
Return	`osid.rules.check.Check`		the check
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getMessage
Description	Gets the message to be returned upon failure of the check evaluation.
Return	`osid.locale.DisplayText`		the message
Compliance	`mandatory`		This method must be implemented.
Method	isWarning
Description	Tests if failure of the check should be interpreted as a warning and not a failure.
Return	`boolean`		`true` if this is a warning, `false` if an error
Compliance	`mandatory`		This method must be implemented.
Method	continueOnFail
Description	Tests if evaluation of the next instruction should continue if the check in this instruction fails. While the overall evaluation of the agenda still fails, if true, allows for other messages to be gathered.
Return	`boolean`		`true` if this processing should continue on failure, `false` if processing should cease upon failure
Compliance	`mandatory`		This method must be implemented.
Method	breakOnSuccess
Description	Tests if evaluation of the next instruction should continue if the check in this instruction succeeds. This flag instructs the evaluator to stop evaluation and return success if this check is positive.
Return	`boolean`		`true` if this processing should break on success, `false` if processing should continue
Compliance	`mandatory`		This method must be implemented.
Method	order
Description	The processing order for this `Instruction` .
Return	`integer`		the processing order
Compliance	`mandatory`		This method must be implemented.
Method	getInstructionRecord
Description	Gets the instruction record corresponding to the given `Instruction` record `Type`. This method is used to retrieve an object implementing the requested record. The `instructionRecordType` may be the `Type` returned in `getRecordTypes()` or any of its parents in a `Type` hierarchy where `hasRecordType(instructionRecordType)` is `true`.
Parameters	`osid.type.Type`	`instructionRecordType`	the type of instruction record to retrieve
Return	`osid.rules.check.records.InstructionRecord`		the instruction record
Errors	NULL_ARGUMENT		`instructionRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`hasRecordType(instructionRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.