public interface DepotSearchSession extends DepotQuerySession
This session provides methods for searching among Depot
objects. The search query is constructed using the DepotQuery.
getDepotsByQuery()
is the basic search method and
returns a list of Depot
objects.A more advanced search may
be performed with getDepotsBySearch().
It accepts a
DepotSearch
in addition to the query for the purpose of specifying
additional options affecting the entire search, such as ordering.
getDepotsBySearch()
returns a DepotSearchResults
that can be used to access the resulting DepotList
or be
used to perform a search within the result set through DepotSearch.
Depots may have a query record indicated by their respective record
types. The query record is accessed via the DepotQuery.
Modifier and Type | Method and Description |
---|---|
DepotQuery |
getDepotQueryFromInspector(DepotQueryInspector depotQueryInspector)
Gets a depot query from an inspector.
|
DepotSearchResults |
getDepotsBySearch(DepotQuery depotQuery,
DepotSearch depotSearch)
Gets the search results matching the given search query using the
given search.
|
DepotSearch |
getDepotSearch()
Gets a depot search.
|
DepotSearchOrder |
getDepotSearchOrder()
Gets a depot search order.
|
canSearchDepots, getDepotQuery, getDepotsByQuery
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
DepotSearch getDepotSearch()
mandatory
- This method must be implemented. DepotSearchOrder getDepotSearchOrder()
DepotSearchOrder
is
supplied to a DepotSearch
to specify the ordering of
results.mandatory
- This method must be implemented. DepotSearchResults getDepotsBySearch(DepotQuery depotQuery, DepotSearch depotSearch) throws OperationFailedException, PermissionDeniedException
depotQuery
- the depot querydepotSearch
- the depot searchNullArgumentException
- depotQuery
or
depotSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- depotQuery
or
depotSearch
is not of this servicemandatory
- This method must be implemented. DepotQuery getDepotQueryFromInspector(DepotQueryInspector depotQueryInspector)
DepotSearchResults.
depotQueryInspector
- a depot query inspectorNullArgumentException
- depotQueryInspector
is null
UnsupportedException
- depotQueryInspector
is not of this servicemandatory
- This method must be implemented.