public interface ParameterProcessorEnablerNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to ParameterProcessorEnabler
objects in this
Configuration.
This also includes existing
ParameterProcessorEnablers
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
ParameterProcessorEnablerLookupSession.
Modifier and Type | Method and Description |
---|---|
void |
acknowledgeParameterProcessorEnablerNotification(Id notificationId)
Acknowledge a parameter processor enabler notification.
|
boolean |
canRegisterForParameterProcessorEnablerNotifications()
Tests if this user can register for
ParameterProcessorEnabler
notifications. |
Configuration |
getConfiguration()
Gets the
Configuration associated with this session. |
Id |
getConfigurationId()
Gets the
Configuration Id associated
with this session. |
void |
registerForChangedParameterProcessorEnabler(Id parameterProcessorEnablerProcessorId)
Registers for notification of an updated parameter processor enabler.
|
void |
registerForChangedParameterProcessorEnablers()
Registers for notification of updated parameter processor enablers.
|
void |
registerForDeletedParameterProcessorEnabler(Id parameterProcessorEnablerId)
Registers for notification of a deleted parameter processor enabler.
|
void |
registerForDeletedParameterProcessorEnablers()
Registers for notification of deleted parameter processor enablers.
|
void |
registerForNewParameterProcessorEnablers()
Register for notifications of new parameter processor enablers.
|
void |
reliableParameterProcessorEnablerNotifications()
Reliable notifications are desired.
|
void |
unreliableParameterProcessorEnablerNotifications()
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 canRegisterForParameterProcessorEnablerNotifications()
ParameterProcessorEnabler
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 reliableParameterProcessorEnablerNotifications()
acknowledgeParameterProcessorEnablerNotification()
.mandatory
- This method is must be implemented. void unreliableParameterProcessorEnablerNotifications()
mandatory
- This method is must be implemented. void acknowledgeParameterProcessorEnablerNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
notificationId
- the Id
of the notificationOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewParameterProcessorEnablers() throws OperationFailedException, PermissionDeniedException
ParameterProcessorEnablerReceiver.newParameterProcessorEnablers()
is invoked when a new ParameterProcessorEnabler
appears in this configuration.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedParameterProcessorEnablers() throws OperationFailedException, PermissionDeniedException
ParameterProcessorEnablerReceiver.changedParameterProcessorEnablers()
is invoked when a parameter processor enabler in this
configuration is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedParameterProcessorEnabler(Id parameterProcessorEnablerProcessorId) throws OperationFailedException, PermissionDeniedException
ProvisionableReceiver.changedParameterProcessorEnablers()
is invoked when the specified parameter processor enabler in
this configuration is changed.parameterProcessorEnablerProcessorId
- the Id
of
the ParameterProcessorEnabler
to monitorNullArgumentException
-
parameterProcessorEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedParameterProcessorEnablers() throws OperationFailedException, PermissionDeniedException
ParameterProcessorEnablerReceiver.deletedParameterProcessorEnablers()
is invoked when a parameter processor enabler is deleted or
removed from this configuration.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedParameterProcessorEnabler(Id parameterProcessorEnablerId) throws OperationFailedException, PermissionDeniedException
ParameterProcessorEnablerReceiver.deletedParameterProcessorEnablers()
is invoked when the specified parameter processor enabler is
deleted or removed from this configuration.parameterProcessorEnablerId
- the Id
of the
ParameterProcessorEnabler
to monitorNullArgumentException
-
parameterProcessorEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.