public interface InstructionSearch extends OsidSearch
The search interface for governing instruction searches.
Modifier and Type | Method and Description |
---|---|
InstructionSearchRecord |
getInstructionSearchRecord(Type instructionSearchRecordType)
Gets the instruction search record corresponding to the given
instruction search record
Type. |
void |
orderInstructionResults(InstructionSearchOrder instructionSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongInstructions(IdList instructionIds)
Execute this search among the given list of instructions.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongInstructions(IdList instructionIds)
instructionIds
- list of instructionsNullArgumentException
- instructionIds
is null
mandatory
- This method must be implemented. void orderInstructionResults(InstructionSearchOrder instructionSearchOrder)
instructionSearchOrder
- instruction search orderNullArgumentException
- instructionSearchOrder
is null
UnsupportedException
- instructionSearchOrder
is not of this servicemandatory
- This method must be implemented. InstructionSearchRecord getInstructionSearchRecord(Type instructionSearchRecordType) throws OperationFailedException, PermissionDeniedException
Type.
This method is used to
retrieve an object implementing the requested record.instructionSearchRecordType
- an instruction search record typeNullArgumentException
-
instructionSearchRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
-
hasRecordType(instructionSearchRecordType)
is
false
mandatory
- This method must be implemented.