public interface QueueConstrainerNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to QueueConstrainer
objects in this FrontFront
Office.
This also includes existing QueueConstrainers
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
QueueConstrainerLookupSession.
Modifier and Type | Method and Description |
---|---|
boolean |
canRegisterForQueueConstrainerNotifications()
Tests if this user can register for
QueueConstrainer
notifications. |
FrontOffice |
getFrontOffice()
Gets the
FrontOffice associated with this session. |
Id |
getFrontOfficeId()
Gets the
FrontOffice Id associated with
this session. |
void |
registerForChangedQueueConstrainer(Id queueConstrainerId)
Registers for notification of an updated queue constrainer.
|
void |
registerForChangedQueueConstrainers()
Registers for notification of updated front office.
|
void |
registerForDeletedQueueConstrainer(Id queueConstrainerId)
Registers for notification of a deleted queue constrainer.
|
void |
registerForDeletedQueueConstrainers()
Registers for notification of deleted queue constrainers.
|
void |
registerForNewQueueConstrainers()
Register for notifications of new queue constrainers.
|
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 canRegisterForQueueConstrainerNotifications()
QueueConstrainer
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 registerForNewQueueConstrainers() throws OperationFailedException, PermissionDeniedException
QueueConstrainerReceiver.newQueueConstrainers()
is invoked
when a new QueueConstrainer
appears in this front
office.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedQueueConstrainers() throws OperationFailedException, PermissionDeniedException
QueueConstrainerReceiver.changedQueueConstrainers()
is invoked
when a queue constrainer in this front office is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedQueueConstrainer(Id queueConstrainerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
ProvisionableReceiver.changedQueueConstrainers()
is invoked
when the specified queue constrainer in this front office is changed.queueConstrainerId
- the Id
of the
QueueConstrainer
to monitorNotFoundException
- a queue constrainer was not found
in this queue matchmaker identified by the given Id
NullArgumentException
- queueConstrainerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedQueueConstrainers() throws OperationFailedException, PermissionDeniedException
QueueConstrainerReceiver.deletedQueueConstrainers()
is invoked
when a queue constrainer is deleted or removed from this front office.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedQueueConstrainer(Id queueConstrainerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
QueueConstrainerReceiver.deletedQueueConstrainers()
is invoked
when the specified queue constrainer is deleted or removed from this
front office.queueConstrainerId
- the Id
of the
QueueConstrainer
to monitorNotFoundException
- a queue constrainer was not found
in this queue matchmaker identified by the given Id
NullArgumentException
- queueConstrainerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.