OSID Logo
OSID Specifications
topology package
Version 3.0.0
Release Candidate Preview
Interfaceosid.topology.GraphNotificationSession
Implementsosid.OsidSession
Description

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

MethodcanRegisterForGraphNotifications
Description

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

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

CompliancemandatoryThis method is must be implemented.
MethodunreliableGraphNotifications
Description

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

CompliancemandatoryThis method is must be implemented.
MethodacknowledgeGraphNotification
Description

Acknowledge a graph notification.

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

Register for notifications of new graphs. GraphReceiver.newGraphs() is invoked when a new Graph is created.

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

Registers for notification of updated graphs. GraphReceiver.changedGraphs() is invoked when a graph is changed.

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

Registers for notification of an updated graph. GraphReceiver.changedGraphs() is invoked when the specified graph is changed.

Parametersosid.id.IdgraphIdthe Id of the Graph to monitor
ErrorsNULL_ARGUMENT graphId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedGraphs
Description

Registers for notification of deleted graphs. GraphReceiver.deletedGraphs() is invoked when a graph is deleted.

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

Registers for notification of a deleted graph. GraphReceiver.deletedGraphs() is invoked when the specified graph is deleted.

Parametersosid.id.IdgraphIdthe Id of the Graph to monitor
ErrorsNULL_ARGUMENT graphId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedGraphHierarchy
Description

Registers for notification of an updated graph hierarchy structure. GraphReceiver.changedChildOfGraphs() is invoked when a node experiences a change in its children.

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

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

Parametersosid.id.IdgraphIdthe Id of the Graph node to monitor
ErrorsNULL_ARGUMENT graphId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedGraphHierarchyForDescendants
Description

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

Parametersosid.id.IdgraphIdthe Id of the Graph node to monitor
ErrorsNULL_ARGUMENT graphId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.