public interface InstructionSearchResults extends OsidSearchResults
This interface provides a means to capture results of a search.
Modifier and Type | Method and Description |
---|---|
InstructionQueryInspector |
getInstructionQueryInspector()
Gets the inspector for the query to examine the terms used in the
search.
|
InstructionList |
getInstructions()
Gets the instruction list resulting from a search.
|
InstructionSearchResultsRecord |
getInstructionSearchResultsRecord(Type instructionSearchRecordType)
Gets the instruction search results record corresponding to the given
instruction search record
Type. |
getResultSize
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
InstructionList getInstructions()
IllegalStateException
- list already retrievedmandatory
- This method must be implemented. InstructionQueryInspector getInstructionQueryInspector()
mandatory
- This method must be implemented. InstructionSearchResultsRecord getInstructionSearchResultsRecord(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.