org.osid.control.rules

Interface DeviceEnablerNotificationSession

All Superinterfaces:

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

public interface DeviceEnablerNotificationSession
extends OsidSession

This session defines methods to receive notifications on adds/changes to DeviceEnabler objects in this System. This also includes existing DeviceEnablers 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 DeviceEnablerLookupSession.

Method Summary

Methods

Modifier and Type	Method and Description
void	acknowledgeDeviceEnablerNotification(Id notificationId) Acknowledge a device enabler notification.
boolean	canRegisterForDeviceEnablerNotifications() Tests if this user can register for DeviceEnabler notifications.
System	getSystem() Gets the System associated with this session.
Id	getSystemId() Gets the System Id associated with this session.
void	registerForChangedDeviceEnabler(Id deviceEnablerId) Registers for notification of an updated device enabler.
void	registerForChangedDeviceEnablers() Registers for notification of updated device enablers.
void	registerForDeletedDeviceEnabler(Id deviceEnablerId) Registers for notification of a deleted device enabler.
void	registerForDeletedDeviceEnablers() Registers for notification of deleted device enablers.
void	registerForNewDeviceEnablers() Register for notifications of new device enablers.
void	reliableDeviceEnablerNotifications() Reliable notifications are desired.
void	unreliableDeviceEnablerNotifications() 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.

canRegisterForDeviceEnablerNotifications

boolean canRegisterForDeviceEnablerNotifications()

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

reliableDeviceEnablerNotifications

void reliableDeviceEnablerNotifications()

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

Compliance:

mandatory - This method is must be implemented.

unreliableDeviceEnablerNotifications

void unreliableDeviceEnablerNotifications()

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

Compliance:

mandatory - This method is must be implemented.

acknowledgeDeviceEnablerNotification

void acknowledgeDeviceEnablerNotification(Id notificationId)
                                          throws OperationFailedException,
                                                 PermissionDeniedException

Acknowledge a device enabler notification.

Parameters:

notificationId - the Id of the notification

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForNewDeviceEnablers

void registerForNewDeviceEnablers()
                                  throws OperationFailedException,
                                         PermissionDeniedException

Register for notifications of new device enablers. DeviceEnablerReceiver.newDeviceEnablers() is invoked when a new DeviceEnabler appears in this system.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedDeviceEnablers

void registerForChangedDeviceEnablers()
                                      throws OperationFailedException,
                                             PermissionDeniedException

Registers for notification of updated device enablers. DeviceEnablerReceiver.changedDeviceEnablers() is invoked when a device enabler in this system is changed.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedDeviceEnabler

void registerForChangedDeviceEnabler(Id deviceEnablerId)
                                     throws OperationFailedException,
                                            PermissionDeniedException

Registers for notification of an updated device enabler. ProvisionableReceiver.changedDeviceEnablers() is invoked when the specified device enabler in this system is changed.

Parameters:

deviceEnablerId - the Id of the DeviceEnabler to monitor

Throws:

NullArgumentException - deviceEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedDeviceEnablers

void registerForDeletedDeviceEnablers()
                                      throws OperationFailedException,
                                             PermissionDeniedException

Registers for notification of deleted device enablers. DeviceEnablerReceiver.deletedDeviceEnablers() is invoked when a device enabler is deleted or removed from this system.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedDeviceEnabler

void registerForDeletedDeviceEnabler(Id deviceEnablerId)
                                     throws OperationFailedException,
                                            PermissionDeniedException

Registers for notification of a deleted device enabler. DeviceEnablerReceiver.deletedDeviceEnablers() is invoked when the specified device enabler is deleted or removed from this system.

Parameters:

deviceEnablerId - the Id of the DeviceEnabler to monitor

Throws:

NullArgumentException - deviceEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.