public interface ValueEnablerNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to ValueEnabler
objects in this Configuration.
This also includes existing ValueEnablers
that may
appear or disappear due to changes in the Configuration
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
ValueEnablerLookupSession.
Modifier and Type | Method and Description |
---|---|
void |
acknowledgeValueEnablerNotification(Id notificationId)
Acknowledge a value enabler notification.
|
boolean |
canRegisterForValueEnablerNotifications()
Tests if this user can register for
ValueEnabler
notifications. |
Configuration |
getConfiguration()
Gets the
Configuration associated with this session. |
Id |
getConfigurationId()
Gets the
Configuration Id associated
with this session. |
void |
registerForChangedValueEnabler(Id valueEnablerId)
Registers for notification of an updated value enabler.
|
void |
registerForChangedValueEnablers()
Registers for notification of updated value enablers.
|
void |
registerForDeletedValueEnabler(Id valueEnablerId)
Registers for notification of a deleted value enabler.
|
void |
registerForDeletedValueEnablers()
Registers for notification of deleted value enablers.
|
void |
registerForNewValueEnablers()
Register for notifications of new value enablers.
|
void |
reliableValueEnablerNotifications()
Reliable notifications are desired.
|
void |
unreliableValueEnablerNotifications()
Unreliable notifications are desired.
|
void |
useFederatedConfigurationView()
Federates the view for methods in this session.
|
void |
useIsolatedConfigurationView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getConfigurationId()
Configuration
Id
associated
with this session. Configuration Id
associated with this
sessionmandatory
- This method must be implemented. Configuration getConfiguration() throws OperationFailedException, PermissionDeniedException
Configuration
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canRegisterForValueEnablerNotifications()
ValueEnabler
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 useFederatedConfigurationView()
mandatory
- This method is must be implemented. void useIsolatedConfigurationView()
mandatory
- This method is must be implemented. void reliableValueEnablerNotifications()
acknowledgeValueEnablerNotification()
.mandatory
- This method is must be implemented. void unreliableValueEnablerNotifications()
mandatory
- This method is must be implemented. void acknowledgeValueEnablerNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
notificationId
- the Id
of the notificationOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewValueEnablers() throws OperationFailedException, PermissionDeniedException
ValueEnablerReceiver.newValueEnablers()
is invoked when a new
ValueEnabler
appears in this configuration.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedValueEnablers() throws OperationFailedException, PermissionDeniedException
ValueEnablerReceiver.changedValueEnablers()
is invoked when a
value enabler in this configuration is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedValueEnabler(Id valueEnablerId) throws OperationFailedException, PermissionDeniedException
ProvisionableReceiver.changedValueEnablers()
is invoked when
the specified value enabler in this configuration is changed.valueEnablerId
- the Id
of the
ValueEnabler
to monitorNullArgumentException
- valueEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedValueEnablers() throws OperationFailedException, PermissionDeniedException
ValueEnablerReceiver.deletedValueEnablers()
is invoked when a
value enabler is deleted or removed from this configuration.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedValueEnabler(Id valueEnablerId) throws OperationFailedException, PermissionDeniedException
ValueEnablerReceiver.deletedValueEnablers()
is invoked when
the specified value enabler is deleted or removed from this
configuration.valueEnablerId
- the Id
of the
ValueEnabler
to monitorNullArgumentException
- valueEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.