public interface QueueProcessorSmartFrontOfficeSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
front office. a QueueProcessorQuery
can be retrieved from
this session and mapped to this FrontOffice
to create a
virtual collection of queue processors. The queue processor may be
sequenced using the QueueProcessorSearchOrder
from this
session.
This FrontOffice
has a default query that matches any
queue processor and a default search order that specifies no sequencing.
The queries may be examined using a QueueProcessorQueryInspector.
The query may be modified by converting the inspector back to a
QueueProcessorQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyQueueProcessorQuery(QueueProcessorQuery queueProcessorQuery)
Applies a queue processor query to this front office.
|
void |
applyQueueProcessorSequencing(QueueProcessorSearchOrder queueProcessorSearchOrder)
Applies a queue processor search order to this front office.
|
boolean |
canManageSmartFrontOffices()
Tests if this user can manage smart front office.
|
FrontOffice |
getFrontOffice()
Gets the
FrontOffice associated with this session. |
Id |
getFrontOfficeId()
Gets the
FrontOffice Id associated with
this session. |
QueueProcessorQuery |
getQueueProcessorQuery()
Gets a queue processor query.
|
QueueProcessorQuery |
getQueueProcessorQueryFromInspector(QueueProcessorQueryInspector queueProcessorQueryInspector)
Gets a queue processor query from an inspector.
|
QueueProcessorSearchOrder |
getQueueProcessorSearchOrder()
Gets a queue processor search order.
|
QueueProcessorQueryInspector |
inspectQueueProcessorQuery()
Gets a queue processor query inspector for this front office.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getFrontOfficeId()
FrontOffice
Id
associated with
this session. FrontOffice Id
associated with this sessionmandatory
- This method must be implemented. FrontOffice getFrontOffice() throws OperationFailedException, PermissionDeniedException
FrontOffice
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canManageSmartFrontOffices()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer operations to unauthorized
users. false
if smart front office management is not
authorized, true
otherwisemandatory
- This method must be implemented. QueueProcessorQuery getQueueProcessorQuery()
mandatory
- This method must be implemented. QueueProcessorSearchOrder getQueueProcessorSearchOrder()
mandatory
- This method must be implemented. void applyQueueProcessorQuery(QueueProcessorQuery queueProcessorQuery) throws OperationFailedException, PermissionDeniedException
queueProcessorQuery
- the queue processor queryNullArgumentException
- queueProcessorQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- queueProcessorQuery
not of this servicemandatory
- This method must be implemented. QueueProcessorQueryInspector inspectQueueProcessorQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyQueueProcessorSequencing(QueueProcessorSearchOrder queueProcessorSearchOrder) throws OperationFailedException, PermissionDeniedException
queueProcessorSearchOrder
- the queue processor search orderNullArgumentException
-
queueProcessorSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- queueProcessorSearchOrder
not of this servicemandatory
- This method must be implemented. QueueProcessorQuery getQueueProcessorQueryFromInspector(QueueProcessorQueryInspector queueProcessorQueryInspector)
queueProcessorQueryInspector
- a queue processor query inspectorNullArgumentException
-
queueProcessorQueryInspector
is null
UnsupportedException
-
queueProcessorQueryInspector
is not of this servicemandatory
- This method must be implemented.