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

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

MethodcanRegisterForProcessNotifications
Description

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

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

CompliancemandatoryThis method is must be implemented.
MethodunreliableProcessNotifications
Description

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

CompliancemandatoryThis method is must be implemented.
MethodacknowledgeProcessNotification
Description

Acknowledge a process notification.

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

Register for notifications of new processes. ProcessReceiver.newProcesses() is invoked when a new Process is created.

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

Registers for notification of updated processes. ProcessReceiver.changedProcesses() is invoked when a process is changed.

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

Registers for notification of an updated process. ProcessReceiver.changedProcesses() is invoked when the specified process is changed.

Parametersosid.id.IdprocessIdthe Id of the Process to monitor
ErrorsNULL_ARGUMENT processId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedProcesses
Description

Registers for notification of deleted processes. ProcessReceiver.deletedProcesses() is invoked when a process is deleted.

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

Registers for notification of a deleted process. ProcessReceiver.deletedProcesses() is invoked when the specified process is deleted.

Parametersosid.id.IdprocessIdthe Id of the Process to monitor
ErrorsNULL_ARGUMENT processId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedProcessHierarchy
Description

Registers for notification of an updated process hierarchy structure. ProcessReceiver.changedChildOfProcesses() is invoked when a node experiences a change in its children.

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

Registers for notification of an updated process hierarchy structure. ProcessReceiver.changedChildOfProcesss() is invoked when the specified node or any of its ancestors experiences a change in its children.

Parametersosid.id.IdprocessIdthe Id of the Process node to monitor
ErrorsNULL_ARGUMENT processId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedProcessHierarchyForDescendants
Description

Registers for notification of an updated process hierarchy structure. ProcessReceiver.changedChildOfProcesses() is invoked when the specified node or any of its descendants experiences a change in its children.

Parametersosid.id.IdprocessIdthe Id of the Process node to monitor
ErrorsNULL_ARGUMENT processId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.