Interface | osid.rules.check.Instruction | ||
---|---|---|---|
Implements | osid.OsidRelationship | ||
osid.OsidEnabler | |||
Description |
A | ||
Method | getAgendaId | ||
Description |
Gets the | ||
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 | ||
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 | getInstructionRecord | ||
Description |
Gets the instruction record corresponding to the given
| ||
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. |