public interface InputEnablerNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to InputEnabler
objects in this System.
This
also includes existing InputEnablers
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
InputEnablerLookupSession.
Modifier and Type | Method and Description |
---|---|
void |
acknowledgeInputEnablerNotification(Id notificationId)
Acknowledge an input enabler notification.
|
boolean |
canRegisterForInputEnablerNotifications()
Tests if this user can register for
InputEnabler
notifications. |
System |
getSystem()
Gets the
System associated with this session. |
Id |
getSystemId()
Gets the
System Id associated with this
session. |
void |
registerForChangedInputEnabler(Id inputEnablerId)
Registers for notification of an updated input enabler.
|
void |
registerForChangedInputEnablers()
Registers for notification of updated system enablers.
|
void |
registerForDeletedInputEnabler(Id inputEnablerId)
Registers for notification of a deleted input enabler.
|
void |
registerForDeletedInputEnablers()
Registers for notification of deleted input enablers.
|
void |
registerForNewInputEnablers()
Register for notifications of new input enablers.
|
void |
reliableInputEnablerNotifications()
Reliable notifications are desired.
|
void |
unreliableInputEnablerNotifications()
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 canRegisterForInputEnablerNotifications()
InputEnabler
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 reliableInputEnablerNotifications()
acknowledgeInputEnablerNotification()
.mandatory
- This method is must be implemented. void unreliableInputEnablerNotifications()
mandatory
- This method is must be implemented. void acknowledgeInputEnablerNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
notificationId
- the Id
of the notificationOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewInputEnablers() throws OperationFailedException, PermissionDeniedException
InputEnablerReceiver.newInputEnablers()
is invoked when a new
InputEnabler
appears in this system.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedInputEnablers() throws OperationFailedException, PermissionDeniedException
InputEnablerReceiver.changedInputEnablers()
is invoked when an
input enabler in this system is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedInputEnabler(Id inputEnablerId) throws OperationFailedException, PermissionDeniedException
ProvisionableReceiver.changedInputEnablers()
is invoked when
the specified input enabler in this system is changed.inputEnablerId
- the Id
of the
InputEnabler
to monitorNullArgumentException
- inputEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedInputEnablers() throws OperationFailedException, PermissionDeniedException
InputEnablerReceiver.deletedInputEnablers()
is invoked when an
input enabler is deleted or removed from this system.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedInputEnabler(Id inputEnablerId) throws OperationFailedException, PermissionDeniedException
InputEnablerReceiver.deletedInputEnablers()
is invoked when
the specified input enabler is deleted or removed from this system.inputEnablerId
- the Id
of the
InputEnabler
to monitorNullArgumentException
- inputEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.