public interface PoolConstrainerSearchSession extends PoolConstrainerQuerySession
This session provides methods for searching among
PoolConstrainer
objects. The search query is constructed using the
PoolConstraineryQuery.
getPoolConstrainersByQuery()
is the basic search method
and returns a list of PoolConstrainers.
A more advanced
search may be performed with getPoolConstrainersBySearch().
It accepts a PoolConstrainerSearch
in addition to the query
for the purpose of specifying additional options affecting the entire
search, such as provisioning. getPoolConstrainersBySearch()
returns a PoolConstrainerSearchResults
that can be used to
access the resulting PoolConstrainerList
or be used to
perform a search within the result set through
PoolConstrainerSearch.
This session defines views that offer differing behaviors for searching.
PoolConstrainers
may have a query record indicated by
their respective record types. The query record is accessed via the
PoolConstrainerQuery.
Modifier and Type | Method and Description |
---|---|
PoolConstrainerQuery |
getPoolConstrainerQueryFromInspector(PoolConstrainerQueryInspector poolConstrainerQueryInspector)
Gets a pool constrainer query from an inspector.
|
PoolConstrainerSearchResults |
getPoolConstrainersBySearch(PoolConstrainerQuery poolConstrainerQuery,
PoolConstrainerSearch poolConstrainerSearch)
Gets the search results matching the given search query using the
given search.
|
PoolConstrainerSearch |
getPoolConstrainerSearch()
Gets a pool constrainer search.
|
PoolConstrainerSearchOrder |
getPoolConstrainerSearchOrder()
Gets a pool constrainer search order.
|
canSearchPoolConstrainers, getDistributor, getDistributorId, getPoolConstrainerQuery, getPoolConstrainersByQuery, useFederatedDistributorView, useIsolatedDistributorView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
PoolConstrainerSearch getPoolConstrainerSearch()
mandatory
- This method must be implemented. PoolConstrainerSearchOrder getPoolConstrainerSearchOrder()
PoolConstrainerSearchOrder
is supplied to a
PoolConstrainerSearch
to specify the ordering of results.mandatory
- This method must be implemented. PoolConstrainerSearchResults getPoolConstrainersBySearch(PoolConstrainerQuery poolConstrainerQuery, PoolConstrainerSearch poolConstrainerSearch) throws OperationFailedException, PermissionDeniedException
poolConstrainerQuery
- the pool constrainer querypoolConstrainerSearch
- the pool constrainer searchNullArgumentException
- poolConstrainerQuery
or poolConstrainerSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- poolConstrainerQuery
or poolConstrainerSearch
is not of this
servicemandatory
- This method must be implemented. PoolConstrainerQuery getPoolConstrainerQueryFromInspector(PoolConstrainerQueryInspector poolConstrainerQueryInspector)
PoolConstrainerSearchResults.
poolConstrainerQueryInspector
- a pool constrainer query
inspectorNullArgumentException
-
poolConstrainerQueryInspector
is null
UnsupportedException
-
poolConstrainerQueryInspector
is not of this servicemandatory
- This method must be implemented.