public interface ProvisionSearchSession extends ProvisionQuerySession
This session provides methods for searching among Provision
objects. The search query is constructed using the
ProvisionQuery.
getProvisionsByQuery()
is the basic search method and
returns a list of Provisions.
A more advanced search may be
performed with getProvisionsBySearch().
It accepts a
ProvisionSearch
in addition to the query for the purpose of
specifying additional options affecting the entire search, such as
ordering. getProvisionsBySearch()
returns a
ProvisionSearchResults
that can be used to access the resulting
ProvisionList
or be used to perform a search within the
result set through ProvisionSearch.
This session defines views that offer differing behaviors for searching.
Provisions may have a record indicated by their respective record
types. The query record is accessed via the ProvisionQuery.
Modifier and Type | Method and Description |
---|---|
ProvisionQuery |
getProvisionQueryFromInspector(ProvisionQueryInspector provisionQueryInspector)
Gets a provision query from an inspector.
|
ProvisionSearchResults |
getProvisionsBySearch(ProvisionQuery provisionQuery,
ProvisionSearch provisionSearch)
Gets the search results matching the given search query using the
given search.
|
ProvisionSearch |
getProvisionSearch()
Gets a provision search.
|
ProvisionSearchOrder |
getProvisionSearchOrder()
Gets a provision search order.
|
canSearchProvisions, getDistributor, getDistributorId, getProvisionQuery, getProvisionsByQuery, useFederatedDistributorView, useIsolatedDistributorView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
ProvisionSearch getProvisionSearch()
mandatory
- This method must be implemented. ProvisionSearchOrder getProvisionSearchOrder()
ProvisionSearchOrder
is supplied to a ProvisionSearch
to specify the
ordering of results.mandatory
- This method must be implemented. ProvisionSearchResults getProvisionsBySearch(ProvisionQuery provisionQuery, ProvisionSearch provisionSearch) throws OperationFailedException, PermissionDeniedException
provisionQuery
- the provision queryprovisionSearch
- the provision searchNullArgumentException
- provisionQuery
or provisionSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- provisionQuery
or
provisionSearch
is not of this servicemandatory
- This method must be implemented. ProvisionQuery getProvisionQueryFromInspector(ProvisionQueryInspector provisionQueryInspector)
ProvisionSearchResults.
provisionQueryInspector
- a provision query inspectorNullArgumentException
- provisionQueryInspector
is null
UnsupportedException
- provisionQueryInspector
is not of this servicemandatory
- This method must be implemented.