Interface | osid.topology.GraphNotificationSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods to receive notifications on
adds/changes to | ||
Method | canRegisterForGraphNotifications | ||
Description |
Tests if this user can register for | ||
Return | boolean | false if notification methods are not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | reliableGraphNotifications | ||
Description |
Reliable notifications are desired. In reliable mode,
notifications are to be acknowledged using | ||
Compliance | mandatory | This method is must be implemented. | |
Method | unreliableGraphNotifications | ||
Description |
Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | acknowledgeGraphNotification | ||
Description |
Acknowledge a graph notification. | ||
Parameters | osid.id.Id | notificationId | the Id of the notification |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForNewGraphs | ||
Description |
Register for notifications of new graphs. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedGraphs | ||
Description |
Registers for notification of updated graphs. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedGraph | ||
Description |
Registers for notification of an updated graph. | ||
Parameters | osid.id.Id | graphId | the Id of the Graph to monitor |
Errors | NULL_ARGUMENT | graphId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedGraphs | ||
Description |
Registers for notification of deleted graphs. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedGraph | ||
Description |
Registers for notification of a deleted graph. | ||
Parameters | osid.id.Id | graphId | the Id of the Graph to monitor |
Errors | NULL_ARGUMENT | graphId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedGraphHierarchy | ||
Description |
Registers for notification of an updated graph
hierarchy structure. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedGraphHierarchyForAncestors | ||
Description |
Registers for notification of an updated graph
hierarchy structure. | ||
Parameters | osid.id.Id | graphId | the Id of the Graph node to monitor |
Errors | NULL_ARGUMENT | graphId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedGraphHierarchyForDescendants | ||
Description |
Registers for notification of an updated graph
hierarchy structure. | ||
Parameters | osid.id.Id | graphId | the Id of the Graph node to monitor |
Errors | NULL_ARGUMENT | graphId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |