Interface | osid.rules.check.InstructionSearch | ||
---|---|---|---|
Implements | osid.OsidSearch | ||
Description |
The search interface for governing instruction searches. | ||
Method | searchAmongInstructions | ||
Description |
Execute this search among the given list of instructions. | ||
Parameters | osid.id.IdList | instructionIds | list of instructions |
Errors | NULL_ARGUMENT | instructionIds is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderInstructionResults | ||
Description |
Specify an ordering to the search results. | ||
Parameters | osid.rules.check.InstructionSearchOrder | instructionSearchOrder | instruction search order |
Errors | NULL_ARGUMENT | instructionSearchOrder is null | |
UNSUPPORTED | instructionSearchOrder is not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getInstructionSearchRecord | ||
Description |
Gets the instruction search record corresponding to the
given instruction search record | ||
Parameters | osid.type.Type | instructionSearchRecordType | an instruction search record type |
Return | osid.rules.check.records.InstructionSearchRecord | the instruction search record | |
Errors | NULL_ARGUMENT | instructionSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | hasRecordType(instructionSearchRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |