public interface ControllerNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to Controller
objects in this System.
This
also includes existing controllers 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
ControllerLookupSession.
Modifier and Type | Method and Description |
---|---|
void |
acknowledgeControllerNotification(Id notificationId)
Acknowledge a controller notification.
|
boolean |
canRegisterForControllerNotifications()
Tests if this user can register for
Controller
notifications. |
System |
getSystem()
Gets the
System associated with this session. |
Id |
getSystemId()
Gets the
System Id associated with this
session. |
void |
registerForChangedController(Id controllerId)
Registers for notification of an updated controller.
|
void |
registerForChangedControllers()
Registers for notification of updated controllers.
|
void |
registerForDeletedController(Id controllerId)
Registers for notification of a deleted controller.
|
void |
registerForDeletedControllers()
Registers for notification of deleted controllers.
|
void |
registerForNewControllers()
Register for notifications of new controllers.
|
void |
reliableControllerNotifications()
Reliable notifications are desired.
|
void |
unreliableControllerNotifications()
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 canRegisterForControllerNotifications()
Controller
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 reliableControllerNotifications()
acknowledgeControllerNotification()
.mandatory
- This method is must be implemented. void unreliableControllerNotifications()
mandatory
- This method is must be implemented. void acknowledgeControllerNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
notificationId
- the Id
of the notificationOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewControllers() throws OperationFailedException, PermissionDeniedException
ControllerReceiver.newControllers()
is invoked when a new
Controller
appears in this system.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedControllers() throws OperationFailedException, PermissionDeniedException
ControllerReceiver.changedControllers()
is invoked when a
controller in this system is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedController(Id controllerId) throws OperationFailedException, PermissionDeniedException
SceneReceiver.changedControllers()
is invoked when the
specified controller in this system is changed.controllerId
- the Id
of the Controller
to monitorNullArgumentException
- controllerId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedControllers() throws OperationFailedException, PermissionDeniedException
ControllerReceiver.deletedControllers()
is invoked when a
controller is deleted or removed from this system.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedController(Id controllerId) throws OperationFailedException, PermissionDeniedException
ControllerReceiver.deletedControllers()
is invoked when the
specified controller is deleted or removed from this system.controllerId
- the Id
of the Controller
to monitorNullArgumentException
- controllerId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.