public interface HoldSearchSession extends HoldQuerySession
This session provides methods for searching among Hold
objects. The search query is constructed using the HoldQuery.
getHoldsByQuery()
is the basic search method and
returns a list of Holds.
A more advanced search may be
performed with getHoldsBySearch().
It accepts a
HoldSearch
in addition to the query for the purpose of specifying
additional options affecting the entire search, such as ordering.
getHoldsBySearch()
returns a HoldSearchResults
that
can be used to access the resulting HoldList
or be used to
perform a search within the result set through HoldSearch.
This session defines views that offer differing behaviors for searching.
Holds may have a query record indicated by their respective record
types. The query record is accessed via the HoldQuery.
Modifier and Type | Method and Description |
---|---|
HoldQuery |
getHoldQueryFromInspector(HoldQueryInspector holdQueryInspector)
Gets a hold query from an inspector.
|
HoldSearchResults |
getHoldsBySearch(HoldQuery holdQuery,
HoldSearch holdSearch)
Gets the search results matching the given search query using the
given search.
|
HoldSearch |
getHoldSearch()
Gets a hold search.
|
HoldSearchOrder |
getHoldSearchOrder()
Gets a hold search order.
|
canSearchHolds, getHoldQuery, getHoldsByQuery, getOubliette, getOublietteId, useFederatedOublietteView, useIsolatedOublietteView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
HoldSearch getHoldSearch()
mandatory
- This method must be implemented. HoldSearchOrder getHoldSearchOrder()
HoldSearchOrder
is
supplied to a HoldSearch
to specify the ordering of
results.mandatory
- This method must be implemented. HoldSearchResults getHoldsBySearch(HoldQuery holdQuery, HoldSearch holdSearch) throws OperationFailedException, PermissionDeniedException
holdQuery
- the hold queryholdSearch
- the hold searchNullArgumentException
- holdQuery
or
holdSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- holdQuery
or
holdSearch
is not of this servicemandatory
- This method must be implemented. HoldQuery getHoldQueryFromInspector(HoldQueryInspector holdQueryInspector)
HoldSearchResults.
holdQueryInspector
- a hold query inspectorNullArgumentException
- holdQueryInspector
is null
UnsupportedException
- holdQueryInspector
is not of this servicemandatory
- This method must be implemented.