org.osid.control

Interface SettingNotificationSession

All Superinterfaces:

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

public interface SettingNotificationSession
extends OsidSession

This session defines methods to receive notifications on adds/changes to Setting 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 SettingLookupSession.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canRegisterForSettingNotifications() Tests if this user can register for Setting notifications.
System	getSystem() Gets the System associated with this session.
Id	getSystemId() Gets the System Id associated with this session.
void	registerForChangedSetting(Id settingId) Registers for notification of an updated setting.
void	registerForChangedSettings() Registers for notification of updated settings.
void	registerForChangedSettingsForController(Id controllerId) Registers for notification of updated settings for the given controller.
void	registerForDeletedSetting(Id settingId) Registers for notification of a deleted setting.
void	registerForDeletedSettings() Registers for notification of deleted settings.
void	registerForDeletedSettingsForController(Id controllerId) Registers for notification of deleted settings for the given controller.
void	registerForNewSettings() Register for notifications of new settings.
void	registerForNewSettingsForController(Id controllerId) Register for notifications of new settings for the given controller.
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.

canRegisterForSettingNotifications

boolean canRegisterForSettingNotifications()

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

registerForNewSettings

void registerForNewSettings()
                            throws OperationFailedException,
                                   PermissionDeniedException

Register for notifications of new settings. SettingReceiver.newSetting() is invoked when a new Setting appears in this system.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForNewSettingsForController

void registerForNewSettingsForController(Id controllerId)
                                         throws OperationFailedException,
                                                PermissionDeniedException

Register for notifications of new settings for the given controller. SettingReceiver.newSetting() is invoked when a new Setting appears in this system.

Parameters:

controllerId - the Id of the controller to monitor

Throws:

NullArgumentException - controllerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedSettings

void registerForChangedSettings()
                                throws OperationFailedException,
                                       PermissionDeniedException

Registers for notification of updated settings. SettingReceiver.changedSetting() is invoked when a setting in this system is changed.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedSettingsForController

void registerForChangedSettingsForController(Id controllerId)
                                             throws OperationFailedException,
                                                    PermissionDeniedException

Registers for notification of updated settings for the given controller. SettingReceiver.changedSetting() is invoked when a setting in this system is changed.

Parameters:

controllerId - the Id of the controller to monitor

Throws:

NullArgumentException - controllerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedSetting

void registerForChangedSetting(Id settingId)
                               throws OperationFailedException,
                                      PermissionDeniedException

Registers for notification of an updated setting. SettingReceiver.changedSetting() is invoked when the specified setting in this system is changed.

Parameters:

settingId - the Id of the Setting to monitor

Throws:

NullArgumentException - settingId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedSettings

void registerForDeletedSettings()
                                throws OperationFailedException,
                                       PermissionDeniedException

Registers for notification of deleted settings. SettingReceiver.deletedSetting() is invoked when a setting is deleted or removed from this system.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedSettingsForController

void registerForDeletedSettingsForController(Id controllerId)
                                             throws OperationFailedException,
                                                    PermissionDeniedException

Registers for notification of deleted settings for the given controller. SettingReceiver.deletedSetting() is invoked when a setting is deleted or removed from this system.

Parameters:

controllerId - the Id of the controller to monitor

Throws:

NullArgumentException - controllerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedSetting

void registerForDeletedSetting(Id settingId)
                               throws OperationFailedException,
                                      PermissionDeniedException

Registers for notification of a deleted setting. SettingReceiver.deletedSetting() is invoked when the specified setting is deleted or removed from this system.

Parameters:

settingId - the Id of the Setting to monitor

Throws:

NullArgumentException - settingId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.