public interface QueueProcessorEnablerNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to QueueProcessorEnabler
objects in this FrontFront
Office.
This also includes existing QueueProcessorEnablers
that may appear or disappear due to changes in the
FrontOffice
hierarchy, This session is intended for consumers
needing to synchronize their state with this service without the use of
polling. Notifications are cancelled when this session is closed.
The two views defined in this session correspond to the views in the
QueueProcessorEnablerLookupSession.
Modifier and Type | Method and Description |
---|---|
boolean |
canRegisterForQueueProcessorEnablerNotifications()
Tests if this user can register for
QueueProcessorEnabler
notifications. |
FrontOffice |
getFrontOffice()
Gets the
FrontOffice associated with this session. |
Id |
getFrontOfficeId()
Gets the
FrontOffice Id associated with
this session. |
void |
registerForChangedQueueProcessorEnabler(Id queueProcessorEnablerId)
Registers for notification of an updated queue processor enabler.
|
void |
registerForChangedQueueProcessorEnablers()
Registers for notification of updated front office enabelrs.
|
void |
registerForDeletedQueueProcessorEnabler(Id queueProcessorEnablerId)
Registers for notification of a deleted queue processor enabler.
|
void |
registerForDeletedQueueProcessorEnablers()
Registers for notification of deleted queue processor enablers.
|
void |
registerForNewQueueProcessorEnablers()
Register for notifications of new queue processor enablers.
|
void |
useFederatedFrontOfficeView()
Federates the view for methods in this session.
|
void |
useIsolatedFrontOfficeView()
Isolates the view for methods in this session.
|
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 canRegisterForQueueProcessorEnablerNotifications()
QueueProcessorEnabler
notifications. A return of true does not guarantee successful
authorization. A return of false indicates that it is known all
methods in this session will result in a PERMISSION_DENIED.
This is intended as a hint to an application that may opt not
to offer notification operations. false
if notification methods are not
authorized, true
otherwisemandatory
- This method must be implemented. void useFederatedFrontOfficeView()
mandatory
- This method is must be implemented. void useIsolatedFrontOfficeView()
mandatory
- This method is must be implemented. void registerForNewQueueProcessorEnablers() throws OperationFailedException, PermissionDeniedException
QueueProcessorEnablerReceiver.newQueueProcessorEnablers()
is
invoked when a new QueueProcessorEnabler
appears in
this front office.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedQueueProcessorEnablers() throws OperationFailedException, PermissionDeniedException
QueueProcessorEnablerReceiver.changedQueueProcessorEnablers()
is invoked when a queue processor enabler in this front office is
changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedQueueProcessorEnabler(Id queueProcessorEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
ProvisionableReceiver.changedQueueProcessorEnablers()
is invoked when the specified queue processor enabler in this front
office is changed.queueProcessorEnablerId
- the Id
of the
QueueProcessorEnabler
to monitorNotFoundException
- a queue processor enabler was not
found in this queue matchmaker identified by the given
Id
NullArgumentException
- queueProcessorEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedQueueProcessorEnablers() throws OperationFailedException, PermissionDeniedException
QueueProcessorEnablerReceiver.deletedQueueProcessorEnablers()
is invoked when a queue processor enabler is deleted or removed from
this front office.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedQueueProcessorEnabler(Id queueProcessorEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
QueueProcessorEnablerReceiver.deletedQueueProcessorEnablers()
is invoked when the specified queue processor enabler is
deleted or removed from this front office.queueProcessorEnablerId
- the Id
of the
QueueProcessorEnabler
to monitorNotFoundException
- a queue processor enabler was not
found in this queue matchmaker identified by the given
Id
NullArgumentException
- queueProcessorEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.