public interface QueueConstrainerSearchSession extends QueueConstrainerQuerySession
This session provides methods for searching among
QueueConstrainer
objects. The search query is constructed using
the QueueConstraineryQuery.
getQueueConstrainersByQuery()
is the basic search
method and returns a list of QueueConstrainers.
A more
advanced search may be performed with
getQueueConstrainersBySearch().
It accepts a
QueueConstrainerSearch
in addition to the query for the purpose of
specifying additional options affecting the entire search, such as
provisioning. getQueueConstrainersBySearch()
returns a
QueueConstrainerSearchResults
that can be used to access
the resulting QueueConstrainerList
or be used to perform a
search within the result set through QueueConstrainerSearch.
This session defines views that offer differing behaviors for searching.
QueueConstrainers
may have a query record indicated by
their respective record types. The query record is accessed via the
QueueConstrainerQuery.
Modifier and Type | Method and Description |
---|---|
QueueConstrainerQuery |
getQueueConstrainerQueryFromInspector(QueueConstrainerQueryInspector queueConstrainerQueryInspector)
Gets a queue constrainer query from an inspector.
|
QueueConstrainerSearchResults |
getQueueConstrainersBySearch(QueueConstrainerQuery queueConstrainerQuery,
QueueConstrainerSearch queueConstrainerSearch)
Gets the search results matching the given search query using the
given search.
|
QueueConstrainerSearch |
getQueueConstrainerSearch()
Gets a queue constrainer search.
|
QueueConstrainerSearchOrder |
getQueueConstrainerSearchOrder()
Gets a queue constrainer search order.
|
canSearchQueueConstrainers, getDistributor, getDistributorId, getQueueConstrainerQuery, getQueueConstrainersByQuery, useFederatedDistributorView, useIsolatedDistributorView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
QueueConstrainerSearch getQueueConstrainerSearch()
mandatory
- This method must be implemented. QueueConstrainerSearchOrder getQueueConstrainerSearchOrder()
QueueConstrainerSearchOrder
is supplied to a
QueueConstrainerSearch
to specify the ordering of results.mandatory
- This method must be implemented. QueueConstrainerSearchResults getQueueConstrainersBySearch(QueueConstrainerQuery queueConstrainerQuery, QueueConstrainerSearch queueConstrainerSearch) throws OperationFailedException, PermissionDeniedException
queueConstrainerQuery
- the queue constrainer queryqueueConstrainerSearch
- the queue constrainer searchNullArgumentException
- queueConstrainerQuery
or queueConstrainerSearch
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- queueConstrainerQuery
or queueConstrainerSearch
is not of
this servicemandatory
- This method must be implemented. QueueConstrainerQuery getQueueConstrainerQueryFromInspector(QueueConstrainerQueryInspector queueConstrainerQueryInspector)
QueueConstrainerSearchResults.
queueConstrainerQueryInspector
- a queue constrainer query
inspectorNullArgumentException
-
queueConstrainerQueryInspector
is null
UnsupportedException
-
queueConstrainerQueryInspector
is not of this servicemandatory
- This method must be implemented.