Interface | osid.rules.check.InstructionSearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getInstructions | ||
Description |
Gets the instruction list resulting from a search. | ||
Return | osid.rules.check.InstructionList | the instruction list | |
Errors | ILLEGAL_STATE | list already retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getInstructionQueryInspector | ||
Description |
Gets the inspector for the query to examine the terms used in the search. | ||
Return | osid.rules.check.InstructionQueryInspector | the instruction query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getInstructionSearchResultsRecord | ||
Description |
Gets the instruction search results record
corresponding to the given instruction search record
| ||
Parameters | osid.type.Type | instructionSearchRecordType | an instruction search record type |
Return | osid.rules.check.records.InstructionSearchResultsRecord | the instruction search results 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. |