OSID Specifications
rules check package
Version 3.1.0
rules check package
Version 3.1.0
| Interface | osid.rules.check.InstructionSearchOrder | ||
|---|---|---|---|
| Implements | osid.OsidRelationshipSearchOrder | ||
osid.OsidRuleApplicatorSearchOrder | |||
| Used By | osid.rules.check.InstructionSearchSession | ||
osid.rules.check.InstructionSmartEngineSession | |||
| Description |
An interface for specifying the ordering of search results. | ||
| Method | orderByAgenda | ||
| Description |
Orders the results by agenda. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsAgendaSearchOrder | ||
| Description |
Tests if an agenda search order is available. | ||
| Return | boolean | true if an agenda search order is available,
false otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAgendaSearchOrder | ||
| Description |
Gets the agenda search order. | ||
| Return | osid.rules.check.AgendaSearchOrder | the agenda search order | |
| Errors | ILLEGAL_STATE | supportsAgendaSearchOrder() is false | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByCheck | ||
| Description |
Orders the results by check. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsCheckSearchOrder | ||
| Description |
Tests if a check search order is available. | ||
| Return | boolean | true if a check search order is available, false
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCheckSearchOrder | ||
| Description |
Gets the check search order. | ||
| Return | osid.rules.check.CheckSearchOrder | the check search order | |
| Errors | ILLEGAL_STATE | supportsCheckSearchOrder() is false | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByMessage | ||
| Description |
Orders the results by message. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByWarning | ||
| Description |
Orders the results by the warning flag. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByContinueOnFail | ||
| Description |
Orders the results by the continue-on-fail flag. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByBreakOnSuccess | ||
| Description |
Orders the results by the break-on-success. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByOrder | ||
| Description |
Orders the results by the processing order. | ||
| Parameters | osid.SearchOrderStyle | style | the search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getInstructionSearchOrderRecord | ||
| Description |
Gets the instruction search order record corresponding
to the given instruction record | ||
| Parameters | osid.type.Type | instructionRecordType | an instruction record type |
| Return | osid.rules.check.records.InstructionSearchOrderRecord | the instruction search order 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. | |