public interface ActionGroupNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to ActionGroup
objects in this System.
This
also includes existing action groups 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
ActionGroupLookupSession.
Modifier and Type | Method and Description |
---|---|
void |
acknowledgeActionGroupNotification(Id notificationId)
Acknowledge a action group notification.
|
boolean |
canRegisterForActionGroupNotifications()
Tests if this user can register for
ActionGroup
notifications. |
System |
getSystem()
Gets the
System associated with this session. |
Id |
getSystemId()
Gets the
System Id associated with this
session. |
void |
registerForChangedActionGroup(Id actionGroupId)
Registers for notification of an updated action group.
|
void |
registerForChangedActionGroups()
Registers for notification of updated action groups.
|
void |
registerForDeletedActionGroup(Id actionGroupId)
Registers for notification of a deleted action group.
|
void |
registerForDeletedActionGroups()
Registers for notification of deleted action groups.
|
void |
registerForNewActionGroups()
Register for notifications of new action groups.
|
void |
reliableActionGroupNotifications()
Reliable notifications are desired.
|
void |
unreliableActionGroupNotifications()
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 canRegisterForActionGroupNotifications()
ActionGroup
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 reliableActionGroupNotifications()
acknowledgeActionGroupNotification()
.mandatory
- This method is must be implemented. void unreliableActionGroupNotifications()
mandatory
- This method is must be implemented. void acknowledgeActionGroupNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
notificationId
- the Id
of the notificationOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewActionGroups() throws OperationFailedException, PermissionDeniedException
ActionGroupReceiver.newActionGroups()
is invoked when a new
ActionGroup
appears in this system.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedActionGroups() throws OperationFailedException, PermissionDeniedException
ActionGroupReceiver.changedActionGroups()
is invoked when an
action group in this system is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedActionGroup(Id actionGroupId) throws OperationFailedException, PermissionDeniedException
ActionGroupReceiver.changedActionGroups()
is invoked when the
specified action group in this system is changed.actionGroupId
- the Id
of the ActionGroup
to monitorNullArgumentException
- actionGroupId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedActionGroups() throws OperationFailedException, PermissionDeniedException
ActionGroupReceiver.deletedActionGroups()
is invoked when an
action group is deleted or removed from this system.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedActionGroup(Id actionGroupId) throws OperationFailedException, PermissionDeniedException
ActionGroupReceiver.deletedActionGroups()
is invoked when the
specified action group is deleted or removed from this system.actionGroupId
- the Id
of the ActionGroup
to monitorNullArgumentException
- actionGroupId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.