public interface QueueProcessorEnablerSearchSession extends QueueProcessorEnablerQuerySession
This session provides methods for searching among
QueueProcessorEnabler
objects. The search query is constructed
using the QueueProcessorEnableryQuery.
getQueueProcessorEnablersByQuery()
is the basic search
method and returns a list of QueueProcessorEnablers.
A more
advanced search may be performed with
getQueueProcessorEnablersBySearch().
It accepts a
QueueProcessorEnablerSearch
in addition to the query for the
purpose of specifying additional options affecting the entire search, such
as tracking. getQueueProcessorEnablersBySearch()
returns a
QueueProcessorEnablerSearchResults
that can be used to
access the resulting QueueProcessorEnablerList
or be used
to perform a search within the result set through
QueueProcessorEnablerSearch.
This session defines views that offer differing behaviors for searching.
QueueProcessorEnablers
may have a query record
indicated by their respective query record types. The record is accessed
via the QueueProcessorEnablerQuery.
Modifier and Type | Method and Description |
---|---|
QueueProcessorEnablerQuery |
getQueueProcessorEnablerQueryFromInspector(QueueProcessorEnablerQueryInspector queueProcessorEnablerQueryInspector)
Gets a queue processor enabler query from an inspector.
|
QueueProcessorEnablerSearchResults |
getQueueProcessorEnablersBySearch(QueueProcessorEnablerQuery queueProcessorEnablerQuery,
QueueProcessorEnablerSearch queueProcessorEnablerSearch)
Gets the search results matching the given search query using the
given search.
|
QueueProcessorEnablerSearch |
getQueueProcessorEnablerSearch()
Gets a queue processor enabler search.
|
QueueProcessorEnablerSearchOrder |
getQueueProcessorEnablerSearchOrder()
Gets a queue processor enabler search order.
|
canSearchQueueProcessorEnablers, getFrontOffice, getFrontOfficeId, getQueueProcessorEnablerQuery, getQueueProcessorEnablersByQuery, useFederatedFrontOfficeView, useIsolatedFrontOfficeView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
QueueProcessorEnablerSearch getQueueProcessorEnablerSearch()
mandatory
- This method must be implemented. QueueProcessorEnablerSearchOrder getQueueProcessorEnablerSearchOrder()
QueueProcessorEnablerSearchOrder
is supplied to a
QueueProcessorEnablerSearch
to specify the ordering of
results.mandatory
- This method must be implemented. QueueProcessorEnablerSearchResults getQueueProcessorEnablersBySearch(QueueProcessorEnablerQuery queueProcessorEnablerQuery, QueueProcessorEnablerSearch queueProcessorEnablerSearch) throws OperationFailedException, PermissionDeniedException
queueProcessorEnablerQuery
- the queue processor enabler queryqueueProcessorEnablerSearch
- the queue processor enabler searchNullArgumentException
-
queueProcessorEnablerQuery
or
queueProcessorEnablerSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
-
queueProcessorEnablerQuery
or
queueProcessorEnablerSearch
is not of this servicemandatory
- This method must be implemented. QueueProcessorEnablerQuery getQueueProcessorEnablerQueryFromInspector(QueueProcessorEnablerQueryInspector queueProcessorEnablerQueryInspector)
QueueProcessorEnablerSearchResults.
queueProcessorEnablerQueryInspector
- a queue processor enabler
query inspectorNullArgumentException
-
queueProcessorEnablerQueryInspector
is null
UnsupportedException
-
queueProcessorEnablerQueryInspector
is not of this
servicemandatory
- This method must be implemented.