public interface QueueConstrainerEnablerSearchSession extends QueueConstrainerEnablerQuerySession
This session provides methods for searching among
QueueConstrainerEnabler
objects. The search query is constructed
using the QueueConstrainerEnableryQuery.
getQueueConstrainerEnablersByQuery()
is the basic
search method and returns a list of QueueConstrainerEnablers.
A more advanced search may be performed with
getQueueConstrainerEnablersBySearch().
It accepts a
QueueConstrainerEnablerSearch
in addition to the query for the
purpose of specifying additional options affecting the entire search, such
as tracking. getQueueConstrainerEnablersBySearch()
returns
a QueueConstrainerEnablerSearchResults
that can be used to
access the resulting QueueConstrainerEnablerList
or be used
to perform a search within the result set through
QueueConstrainerEnablerSearch.
This session defines views that offer differing behaviors for searching.
QueueConstrainerEnablers
may have a query record
indicated by their respective record types. The query record is accessed
via the QueueConstrainerEnablerQuery.
Modifier and Type | Method and Description |
---|---|
QueueConstrainerEnablerQuery |
getQueueConstrainerEnablerQueryFromInspector(QueueConstrainerEnablerQueryInspector queueConstrainerEnablerQueryInspector)
Gets a queue constrainer enabler query from an inspector.
|
QueueConstrainerEnablerSearchResults |
getQueueConstrainerEnablersBySearch(QueueConstrainerEnablerQuery queueConstrainerEnablerQuery,
QueueConstrainerEnablerSearch queueConstrainerEnablerSearch)
Gets the search results matching the given search query using the
given search.
|
QueueConstrainerEnablerSearch |
getQueueConstrainerEnablerSearch()
Gets a queue constrainer enabler search.
|
QueueConstrainerEnablerSearchOrder |
getQueueConstrainerEnablerSearchOrder()
Gets a queue constrainer enabler search order.
|
canSearchQueueConstrainerEnablers, getFrontOffice, getFrontOfficeId, getQueueConstrainerEnablerQuery, getQueueConstrainerEnablersByQuery, useFederatedFrontOfficeView, useIsolatedFrontOfficeView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
QueueConstrainerEnablerSearch getQueueConstrainerEnablerSearch()
mandatory
- This method must be implemented. QueueConstrainerEnablerSearchOrder getQueueConstrainerEnablerSearchOrder()
QueueConstrainerEnablerSearchOrder
is supplied to a
QueueConstrainerEnablerSearch
to specify the ordering of
results.mandatory
- This method must be implemented. QueueConstrainerEnablerSearchResults getQueueConstrainerEnablersBySearch(QueueConstrainerEnablerQuery queueConstrainerEnablerQuery, QueueConstrainerEnablerSearch queueConstrainerEnablerSearch) throws OperationFailedException, PermissionDeniedException
queueConstrainerEnablerQuery
- the queue constrainer enabler
queryqueueConstrainerEnablerSearch
- the queue constrainer enabler
searchNullArgumentException
-
queueConstrainerEnablerQuery
or
queueConstrainerEnablerSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
-
queueConstrainerEnablerQuery
or
queueConstrainerEnablerSearch
is not of this servicemandatory
- This method must be implemented. QueueConstrainerEnablerQuery getQueueConstrainerEnablerQueryFromInspector(QueueConstrainerEnablerQueryInspector queueConstrainerEnablerQueryInspector)
QueueConstrainerEnablerSearchResults.
queueConstrainerEnablerQueryInspector
- a queue constrainer
enabler query inspectorNullArgumentException
-
queueConstrainerEnablerQueryInspector
is null
UnsupportedException
-
queueConstrainerEnablerQueryInspector
is not of this
servicemandatory
- This method must be implemented.