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

This session defines methods to receive notifications on adds/changes to State objects in this Process. This also includes existing states that may appear or disappear due to changes in the Process 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 StateLookupSession.

MethodgetProcessId
Description

Gets the Process Id associated with this session.

Returnosid.id.Idthe Process Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetProcess
Description

Gets the Process associated with this session.

Returnosid.process.Processthe Process associated with this session
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanRegisterForStateNotifications
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.
MethoduseFederatedProcessView
Description

Federates the view for methods in this session. A federated view will include states in processes which are children of this process in the process hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedProcessView
Description

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

CompliancemandatoryThis method is must be implemented.
MethodreliableStateNotifications
Description

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

CompliancemandatoryThis method is must be implemented.
MethodunreliableStateNotifications
Description

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

CompliancemandatoryThis method is must be implemented.
MethodacknowledgeStateNotification
Description

Acknowledge a state notification.

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

Register for notifications of new states. StateReceiver.newStates() is invoked when a new State is appears in this process.

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

Registers for notification of updated states. StateReceiver.changedStates() is invoked when a state in this process is changed.

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

Registers for notification of an updated state. StateReceiver.changedStates() is invoked when the specified state in this process is changed.

Parametersosid.id.IdstateIdthe Id of the State to monitor
ErrorsNULL_ARGUMENT stateId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedStates
Description

Registers for notification of deleted states. StateReceiver.deletedStates() is invoked when a state is deleted or removed from this process.

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

Registers for notification of a deleted state. StateReceiver.deletedStates() is invoked when the specified state is deleted or removed from this process.

Parametersosid.id.IdstateIdthe Id of the State to monitor
ErrorsNULL_ARGUMENT stateId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.