public interface BlockSearch extends OsidSearch
The search interface for governing block searches.
Modifier and Type | Method and Description |
---|---|
BlockSearchRecord |
getBlockSearchRecord(Type blockSearchRecordType)
Gets the block search record corresponding to the given block search
record
Type. |
void |
orderBlockResults(BlockSearchOrder blockSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongBlocks(IdList blockIds)
Execute this search among the given list of blocks.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongBlocks(IdList blockIds)
blockIds
- list of blocksNullArgumentException
- blockIds
is
null
mandatory
- This method must be implemented. void orderBlockResults(BlockSearchOrder blockSearchOrder)
blockSearchOrder
- block search orderNullArgumentException
- blockSearchOrder
is null
UnsupportedException
- blockSearchOrder
is not of this servicemandatory
- This method must be implemented. BlockSearchRecord getBlockSearchRecord(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.