public interface BinSearchSession extends BinQuerySession
This session provides methods for searching among Bin
objects. The search query is constructed using the BinQuery.
getBinsByQuery()
is the basic search method and returns
a list of Bin
objects.A more advanced search may be
performed with getBinsBySearch().
It accepts a
BinSearch
in addition to the query for the purpose of specifying
additional options affecting the entire search, such as ordering.
getBinsBySearch()
returns a BinSearchResults
that
can be used to access the resulting BinList
or be used to
perform a search within the result set through BinSearch.
Bins may have a bin query record indicated by their respective record
types. The bin query record is accessed via the BinQuery.
Modifier and Type | Method and Description |
---|---|
BinQuery |
getBinQueryFromInspector(BinQueryInspector binQueryInspector)
Gets a bin query from an inspector.
|
BinSearchResults |
getBinsBySearch(BinQuery binQuery,
BinSearch binSearch)
Gets the search results matching the given search query using the
given search.
|
BinSearch |
getBinSearch()
Gets a bin search.
|
BinSearchOrder |
getBinSearchOrder()
Gets a bin search order.
|
canSearchBins, getBinQuery, getBinsByQuery
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
BinSearch getBinSearch()
mandatory
- This method must be implemented. BinSearchOrder getBinSearchOrder()
BinSearchOrder
is supplied
to a BinSearch
to specify the ordering of results.mandatory
- This method must be implemented. BinSearchResults getBinsBySearch(BinQuery binQuery, BinSearch binSearch) throws OperationFailedException, PermissionDeniedException
binQuery
- the bin querybinSearch
- the bin searchNullArgumentException
- binQuery
or
binSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- binQuery
or
binSearch
is not of this servicemandatory
- This method must be implemented. BinQuery getBinQueryFromInspector(BinQueryInspector binQueryInspector)
BinSearchResults.
binQueryInspector
- a bin query inspectorNullArgumentException
- binQueryInspector
is null
UnsupportedException
- binQueryInspector
is not of this servicemandatory
- This method must be implemented.