public interface ActionEnablerNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to ActionEnabler
objects in this System.
This also includes existing ActionEnablers
that may appear
or disappear due to changes in the System
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
ActionEnablerLookupSession.
Modifier and Type | Method and Description |
---|---|
void |
acknowledgeActionEnablerNotification(Id notificationId)
Acknowledge an action enabler notification.
|
boolean |
canRegisterForActionEnablerNotifications()
Tests if this user can register for
ActionEnabler
notifications. |
System |
getSystem()
Gets the
System associated with this session. |
Id |
getSystemId()
Gets the
System Id associated with this
session. |
void |
registerForChangedActionEnabler(Id actionEnablerId)
Registers for notification of an updated action enabler.
|
void |
registerForChangedActionEnablers()
Registers for notification of updated action enablers.
|
void |
registerForDeletedActionEnabler(Id actionEnablerId)
Registers for notification of a deleted action enabler.
|
void |
registerForDeletedActionEnablers()
Registers for notification of deleted action enablers.
|
void |
registerForNewActionEnablers()
Register for notifications of new action enablers.
|
void |
reliableActionEnablerNotifications()
Reliable notifications are desired.
|
void |
unreliableActionEnablerNotifications()
Unreliable notifications are desired.
|
void |
useFederatedSystemView()
Federates the view for methods in this session.
|
void |
useIsolatedSystemView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getSystemId()
System
Id
associated with this
session. System Id
associated with this sessionmandatory
- This method must be implemented. System getSystem() throws OperationFailedException, PermissionDeniedException
System
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canRegisterForActionEnablerNotifications()
ActionEnabler
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 useFederatedSystemView()
mandatory
- This method is must be implemented. void useIsolatedSystemView()
mandatory
- This method is must be implemented. void reliableActionEnablerNotifications()
acknowledgeActionEnablerNotification()
.mandatory
- This method is must be implemented. void unreliableActionEnablerNotifications()
mandatory
- This method is must be implemented. void acknowledgeActionEnablerNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
notificationId
- the Id
of the notificationOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewActionEnablers() throws OperationFailedException, PermissionDeniedException
ActionEnablerReceiver.newActionEnablers()
is invoked when a
new ActionEnabler
appears in this system.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedActionEnablers() throws OperationFailedException, PermissionDeniedException
ActionEnablerReceiver.changedActionEnablers()
is invoked when
an action enabler in this system is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedActionEnabler(Id actionEnablerId) throws OperationFailedException, PermissionDeniedException
ProvisionableReceiver.changedActionEnablers()
is invoked when
the specified action enabler in this system is changed.actionEnablerId
- the Id
of the
ActionEnabler
to monitorNullArgumentException
- actionEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedActionEnablers() throws OperationFailedException, PermissionDeniedException
ActionEnablerReceiver.deletedActionEnablers()
is invoked when
an action enabler is deleted or removed from this system.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedActionEnabler(Id actionEnablerId) throws OperationFailedException, PermissionDeniedException
ActionEnablerReceiver.deletedActionEnablers()
is invoked when
the specified action enabler is deleted or removed from this system.actionEnablerId
- the Id
of the
ActionEnabler
to monitorNullArgumentException
- actionEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.