public interface QueueConstrainerEnablerNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to QueueConstrainerEnabler
objects in this
Distributor.
This also includes existing
QueueConstrainerEnablers
that may appear or disappear due to
changes in the Distributor
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
QueueConstrainerEnablerLookupSession.
Modifier and Type | Method and Description |
---|---|
boolean |
canRegisterForQueueConstrainerEnablerNotifications()
Tests if this user can register for
QueueConstrainerEnabler
notifications. |
Distributor |
getDistributor()
Gets the
Distributor associated with this session. |
Id |
getDistributorId()
Gets the
Distributor Id associated with
this session. |
void |
registerForChangedQueueConstrainerEnabler(Id queueConstrainerEnablerId)
Registers for notification of an updated queue constrainer enabler.
|
void |
registerForChangedQueueConstrainerEnablers()
Registers for notification of updated distributor enabelrs.
|
void |
registerForDeletedQueueConstrainerEnabler(Id queueConstrainerEnablerId)
Registers for notification of a deleted queue constrainer enabler.
|
void |
registerForDeletedQueueConstrainerEnablers()
Registers for notification of deleted queue constrainer enablers.
|
void |
registerForNewQueueConstrainerEnablers()
Register for notifications of new queue constrainer enablers.
|
void |
useFederatedDistributorView()
Federates the view for methods in this session.
|
void |
useIsolatedDistributorView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getDistributorId()
Distributor
Id
associated with
this session. Distributor Id
associated with this sessionmandatory
- This method must be implemented. Distributor getDistributor() throws OperationFailedException, PermissionDeniedException
Distributor
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canRegisterForQueueConstrainerEnablerNotifications()
QueueConstrainerEnabler
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 useFederatedDistributorView()
mandatory
- This method is must be implemented. void useIsolatedDistributorView()
mandatory
- This method is must be implemented. void registerForNewQueueConstrainerEnablers() throws OperationFailedException, PermissionDeniedException
QueueConstrainerEnablerReceiver.newQueueConstrainerEnablers()
is invoked when a new QueueConstrainerEnabler
appears
in this distributor.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedQueueConstrainerEnablers() throws OperationFailedException, PermissionDeniedException
QueueConstrainerEnablerReceiver.changedQueueConstrainerEnablers()
is invoked when a queue constrainer enabler in this
distributor is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedQueueConstrainerEnabler(Id queueConstrainerEnablerId) throws OperationFailedException, PermissionDeniedException
ProvisionableReceiver.changedQueueConstrainerEnablers()
is invoked when the specified queue constrainer enabler in this
distributor is changed.queueConstrainerEnablerId
- the Id
of the
QueueConstrainerEnabler
to monitorNullArgumentException
-
queueConstrainerEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedQueueConstrainerEnablers() throws OperationFailedException, PermissionDeniedException
QueueConstrainerEnablerReceiver.deletedQueueConstrainerEnablers()
is invoked when a queue constrainer enabler is deleted or
removed from this distributor.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedQueueConstrainerEnabler(Id queueConstrainerEnablerId) throws OperationFailedException, PermissionDeniedException
QueueConstrainerEnablerReceiver.deletedQueueConstrainerEnablers()
is invoked when the specified queue constrainer enabler is
deleted or removed from this distributor.queueConstrainerEnablerId
- the Id
of the
QueueConstrainerEnabler
to monitorNullArgumentException
-
queueConstrainerEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.