public interface ProvisionableSearchSession extends ProvisionableQuerySession
This session provides methods for searching among Provisionable
objects. The search query is constructed using the
ProvisionableQuery.
getProvisionablesByQuery()
is the basic search method
and returns a list of Provisionables.
A more advanced
search may be performed with getProvisionablesBySearch().
It accepts an ProvisionableSearch
in addition to the query
for the purpose of specifying additional options affecting the entire
search, such as ordering. getProvisionablesBySearch()
returns an ProvisionableSearchResults
that can be used to
access the resulting ProvisionableList
or be used to
perform a search within the result set through ProvisionableSearch.
This session defines views that offer differing behaviors for searching.
Provisionables may have a query record indicated by their respective
record types. The query record is accessed via the
ProvisionableQuery.
Modifier and Type | Method and Description |
---|---|
ProvisionableQuery |
getProvisionableQueryFromInspector(ProvisionableQueryInspector provisionableQueryInspector)
Gets a provisionable query from an inspector.
|
ProvisionableSearchResults |
getProvisionablesBySearch(ProvisionableQuery provisionableQuery,
ProvisionableSearch provisionableSearch)
Gets the search results matching the given search query using the
given search.
|
ProvisionableSearch |
getProvisionableSearch()
Gets a provisionable search.
|
ProvisionableSearchOrder |
getProvisionableSearchOrder()
Gets a provisionable search order.
|
canSearchProvisionables, getDistributor, getDistributorId, getProvisionableQuery, getProvisionablesByQuery, useFederatedDistributorView, useIsolatedDistributorView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
ProvisionableSearch getProvisionableSearch()
mandatory
- This method must be implemented. ProvisionableSearchOrder getProvisionableSearchOrder()
ProvisionableSearchOrder
is supplied to a ProvisionableSearch
to specify
the ordering of results.mandatory
- This method must be implemented. ProvisionableSearchResults getProvisionablesBySearch(ProvisionableQuery provisionableQuery, ProvisionableSearch provisionableSearch) throws OperationFailedException, PermissionDeniedException
provisionableQuery
- the provisionable queryprovisionableSearch
- the provisionable searchNullArgumentException
- provisionableQuery
or provisionableSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- provisionableQuery
or provisionableSearch
is not of this
servicemandatory
- This method must be implemented. ProvisionableQuery getProvisionableQueryFromInspector(ProvisionableQueryInspector provisionableQueryInspector)
ProvisionableSearchResults.
provisionableQueryInspector
- a provisionable query inspectorNullArgumentException
-
provisionableQueryInspector
is null
UnsupportedException
-
provisionableQueryInspector
is not of this servicemandatory
- This method must be implemented.