OSID Logo
OSID Specifications
process package
Version 3.0.0
Release Candidate Preview
Interfaceosid.process.StateChangeNotificationSession
Implementsosid.OsidSession
Description

This session defines methods to receive notifications on changes of object states. 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

MethodcanRegisterForStateChangeNotifications
Description

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

Returnboolean false if notification methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodreliableStateChangeNotifications
Description

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

CompliancemandatoryThis method is must be implemented.
MethodunreliableStateChangeNotifications
Description

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

CompliancemandatoryThis method is must be implemented.
MethodacknowledgeStateChangeNotification
Description

Acknowledge a state change notification.

Parametersosid.id.IdnotificationIdthe Id of the notification
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedState
Description

Registers for notification of updated states. StateChangeReceiver.changedState() is invoked when a state is changed.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedState
Description

Registers for notification of an updated state. StateChangeReceiver.changedState() is invoked when the specified state is changed.

Parametersosid.id.Ididthe Id to monitor
ErrorsNULL_ARGUMENT id is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.