public interface BlockSearchResults extends OsidSearchResults
This interface provides a means to capture results of a search.
Modifier and Type | Method and Description |
---|---|
BlockQueryInspector |
getBlockQueryInspector()
Gets the inspector for the query to examine the terms used in the
search.
|
BlockList |
getBlocks()
Gets the block list resulting from a search.
|
BlockSearchResultsRecord |
getBlockSearchResultsRecord(Type blockSearchRecordType)
Gets the block search results record corresponding to the given block
search record
Type. |
getResultSize
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
BlockList getBlocks()
IllegalStateException
- list already retrievedmandatory
- This method must be implemented. BlockQueryInspector getBlockQueryInspector()
mandatory
- This method must be implemented. BlockSearchResultsRecord getBlockSearchResultsRecord(Type blockSearchRecordType) throws OperationFailedException, PermissionDeniedException
Type.
This method is used to retrieve an
object implementing the requested record.blockSearchRecordType
- a block search record typeNullArgumentException
- blockSearchRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
-
hasRecordType(blockSearchRecordType)
is false
mandatory
- This method must be implemented.