Interface | osid.topology.path.PathNotificationSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods to receive notifications on
adds/changes to The two views defined in this session correspond to the
views in the | ||
Method | getGraphId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Graph Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getGraph | ||
Description |
Gets the | ||
Return | osid.topology.Graph | the graph | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canRegisterForPathNotifications | ||
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 | useFederatedGraphView | ||
Description |
Federates the view for methods in this session. A federated view will include paths in graphs which are children of this graph in the graph hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedGraphView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts notifications to this graph only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | reliablePathNotifications | ||
Description |
Reliable notifications are desired. In reliable mode,
notifications are to be acknowledged using | ||
Compliance | mandatory | This method is must be implemented. | |
Method | unreliablePathNotifications | ||
Description |
Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | acknowledgePathNotification | ||
Description |
Acknowledge a path 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 | registerForNewPaths | ||
Description |
Register for notifications of new paths. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForNewPathsByGenusType | ||
Description |
Register for notifications of new paths of the given
genus type. | ||
Parameters | osid.type.Type | pathGenusType | a path genus type |
Errors | NULL_ARGUMENT | pathGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForNewPathsForStartingNode | ||
Description |
Register for notifications of new paths from the given
node. | ||
Parameters | osid.id.Id | nodeId | the Id of the Node to monitor |
Errors | NULL_ARGUMENT | nodeId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForNewPathsForEndingNode | ||
Description |
Register for notifications of new paths to the given
node. | ||
Parameters | osid.id.Id | nodeId | the Id of the Node to monitor |
Errors | NULL_ARGUMENT | nodeId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedPaths | ||
Description |
Registers for notification of updated paths. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedPathsByGenusType | ||
Description |
Registers for notification of updated paths of the
given genus type. | ||
Parameters | osid.type.Type | pathGenusType | a path genus type |
Errors | NULL_ARGUMENT | pathGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedPathsForStartingNode | ||
Description |
Registers for notification of updated paths from the
given node. | ||
Parameters | osid.id.Id | nodeId | the Id of the Node to monitor |
Errors | NULL_ARGUMENT | nodeId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedPathsForEndingNode | ||
Description |
Registers for notification of updated paths to the
given node. | ||
Parameters | osid.id.Id | nodeId | the Id of the Node to monitor |
Errors | NULL_ARGUMENT | nodeId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedPath | ||
Description |
Registers for notification of an updated path. | ||
Parameters | osid.id.Id | pathId | the Id of the Path to monitor |
Errors | NULL_ARGUMENT | pathId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedPaths | ||
Description |
Registers for notification of deleted paths. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedPathsByGenusType | ||
Description |
Registers for notification of deleted paths of the
given genus type. | ||
Parameters | osid.type.Type | pathGenusType | a path genus type |
Errors | NULL_ARGUMENT | pathGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedPathsForStartingNode | ||
Description |
Register for notifications of removed paths from the
given node. | ||
Parameters | osid.id.Id | nodeId | the Id of the Node to monitor |
Errors | NULL_ARGUMENT | nodeId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedPathsForEndingNode | ||
Description |
Register for notifications of removed paths to the
given node. | ||
Parameters | osid.id.Id | nodeId | the Id of the Node to monitor |
Errors | NULL_ARGUMENT | nodeId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedPath | ||
Description |
Registers for notification of a deleted path. | ||
Parameters | osid.id.Id | pathId | the Id of the Path to monitor |
Errors | NULL_ARGUMENT | pathId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |