Interface | osid.rules.check.InstructionSearchSession | ||
---|---|---|---|
Implements | osid.rules.check.InstructionQuerySession | ||
Description |
This session provides methods for searching among This session defines views that offer differing behaviors for searching.
Instructions may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
Method | getInstructionSearch | ||
Description |
Gets an instruction search. | ||
Return | osid.rules.check.InstructionSearch | the instruction search | |
Compliance | mandatory | This method must be implemented. | |
Method | getInstructionSearchOrder | ||
Description |
Gets an instruction search order. The | ||
Return | osid.rules.check.InstructionSearchOrder | the instruction search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getInstructionsBySearch | ||
Description |
Gets the search results matching the given search query using the given search. | ||
Parameters | osid.rules.check.InstructionQuery | instructionQuery | the instruction query |
osid.rules.check.InstructionSearch | instructionSearch | the instruction search | |
Return | osid.rules.check.InstructionSearchResults | the instruction search results | |
Errors | NULL_ARGUMENT | instructionQuery or instructionSearch is
null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | instructionQuery or instructionSearch is not
of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getInstructionQueryFromInspector | ||
Description |
Gets an instruction query. from an inspector. The
inspector is available from an | ||
Parameters | osid.rules.check.InstructionQueryInspector | instructionQueryInspector | an instruction query inspector |
Return | osid.rules.check.InstructionQuery | the instruction query | |
Errors | NULL_ARGUMENT | instructionQueryInspector is null | |
UNSUPPORTED | instructionQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |