public interface BlockSearchSession extends BlockQuerySession
This session provides methods for searching among Block
objects. The search query is constructed using the BlockQuery.
getBlocksByQuery()
is the basic search method and
returns a list of Blocks.
A more advanced search may be
performed with getBlocksBySearch().
It accepts a
BlockSearch
in addition to the query for the purpose of specifying
additional options affecting the entire search, such as ordering.
getBlocksBySearch()
returns a BlockSearchResults
that can be used to access the resulting BlockList
or be
used to perform a search within the result set through BlockSearch.
This session defines views that offer differing behaviors for searching.
Blocks may have a query record indicated by their respective record
types. The query record is accessed via the BlockQuery.
Modifier and Type | Method and Description |
---|---|
BlockQuery |
getBlockQueryFromInspector(BlockQueryInspector blockQueryInspector)
Gets a block query from an inspector.
|
BlockSearchResults |
getBlocksBySearch(BlockQuery blockQuery,
BlockSearch blockSearch)
Gets the search results matching the given search query using the
given search.
|
BlockSearch |
getBlockSearch()
Gets a block search.
|
BlockSearchOrder |
getBlockSearchOrder()
Gets a block search order.
|
canSearchBlocks, getBlockQuery, getBlocksByQuery, getOubliette, getOublietteId, useFederatedOublietteView, useIsolatedOublietteView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
BlockSearch getBlockSearch()
mandatory
- This method must be implemented. BlockSearchOrder getBlockSearchOrder()
BlockSearchOrder
is
supplied to a BlockSearch
to specify the ordering of
results.mandatory
- This method must be implemented. BlockSearchResults getBlocksBySearch(BlockQuery blockQuery, BlockSearch blockSearch) throws OperationFailedException, PermissionDeniedException
blockQuery
- the block queryblockSearch
- the block searchNullArgumentException
- blockQuery
or
blockSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- blockQuery
or
blockSearch
is not of this servicemandatory
- This method must be implemented. BlockQuery getBlockQueryFromInspector(BlockQueryInspector blockQueryInspector)
BlockSearchResults.
blockQueryInspector
- a block query inspectorNullArgumentException
- blockQueryInspector
is null
UnsupportedException
- blockQueryInspector
is not of this servicemandatory
- This method must be implemented.