org.osid.control

Interface SceneNotificationSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface SceneNotificationSession
extends OsidSession

This session defines methods to receive notifications on adds/changes to Scene objects in this dDstributor. 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 SceneLookupSession.

Method Summary

Methods

Modifier and Type	Method and Description
void	acknowledgeSceneNotification(Id notificationId) Acknowledge a scene notification.
boolean	canRegisterForSceneNotifications() Tests if this user can register for Scene notifications.
System	getSystem() Gets the System associated with this session.
Id	getSystemId() Gets the System Id associated with this session.
void	registerForChangedScene(Id sceneId) Registers for notification of an updated scene.
void	registerForChangedScenes() Registers for notification of updated scenes.
void	registerForDeletedScene(Id sceneId) Registers for notification of a deleted scene.
void	registerForDeletedScenes() Registers for notification of deleted scenes.
void	registerForNewScenes() Register for notifications of new scenes.
void	reliableSceneNotifications() Reliable notifications are desired.
void	unreliableSceneNotifications() Unreliable notifications are desired.
void	useFederatedSystemView() Federates the view for methods in this session.
void	useIsolatedSystemView() Isolates the view for methods in this session.

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getSystemId

Id getSystemId()

Gets the System Id associated with this session.

Returns:

the System Id associated with this session

Compliance:

mandatory - This method must be implemented.

getSystem

System getSystem()
                 throws OperationFailedException,
                        PermissionDeniedException

Gets the System associated with this session.

Returns:

the system

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canRegisterForSceneNotifications

boolean canRegisterForSceneNotifications()

Tests if this user can register for Scene 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.

Returns:

false if notification methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useFederatedSystemView

void useFederatedSystemView()

Federates the view for methods in this session. A federated view will include scenes in systems which are children of this system in the system hierarchy.

Compliance:

mandatory - This method is must be implemented.

useIsolatedSystemView

void useIsolatedSystemView()

Isolates the view for methods in this session. An isolated view restricts notifications to this system only.

Compliance:

mandatory - This method is must be implemented.

reliableSceneNotifications

void reliableSceneNotifications()

Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using acknowledgeSceneNotification() .

Compliance:

mandatory - This method is must be implemented.

unreliableSceneNotifications

void unreliableSceneNotifications()

Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.

Compliance:

mandatory - This method is must be implemented.

acknowledgeSceneNotification

void acknowledgeSceneNotification(Id notificationId)
                                  throws OperationFailedException,
                                         PermissionDeniedException

Acknowledge a scene notification.

Parameters:

notificationId - the Id of the notification

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForNewScenes

void registerForNewScenes()
                          throws OperationFailedException,
                                 PermissionDeniedException

Register for notifications of new scenes. SceneReceiver.newScenes() is invoked when a new Scene appears in this system.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedScenes

void registerForChangedScenes()
                              throws OperationFailedException,
                                     PermissionDeniedException

Registers for notification of updated scenes. SceneReceiver.changedScenes() is invoked when a scene in this system is changed.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedScene

void registerForChangedScene(Id sceneId)
                             throws OperationFailedException,
                                    PermissionDeniedException

Registers for notification of an updated scene. SceneReceiver.changedScenes() is invoked when the specified scene in this system is changed.

Parameters:

sceneId - the Id of the Scene to monitor

Throws:

NullArgumentException - sceneId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedScenes

void registerForDeletedScenes()
                              throws OperationFailedException,
                                     PermissionDeniedException

Registers for notification of deleted scenes. SceneReceiver.deletedScenes() is invoked when a scene is deleted or removed from this system.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedScene

void registerForDeletedScene(Id sceneId)
                             throws OperationFailedException,
                                    PermissionDeniedException

Registers for notification of a deleted scene. SceneReceiver.deletedScenes() is invoked when the specified scene is deleted or removed from this system.

Parameters:

sceneId - the Id of the Scene to monitor

Throws:

NullArgumentException - sceneId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.