| Interface | osid.topology.TopologyProxyManager | ||
|---|---|---|---|
| Implements | osid.OsidProxyManager | ||
osid.topology.TopologyProfile | |||
| Description |
The topology manager provides access to topology sessions
and provides interoperability tests for various aspects of
this service. Methods in this manager include a
| ||
| Method | getTopologyTraversalSession | ||
| Description |
Gets the | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy |
| Return | osid.topology.TopologyTraversalSession | a TopologyTraversalSession | |
| Errors | NULL_ARGUMENT | proxy is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsTopologyTraversal() is false | ||
| Compliance | optional | This method must be implemented if supportsTopologyTraversal()
is true. | |
| Method | getTopologyTraversalForGraph | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | graphId | the Id of the graph |
osid.proxy.Proxy | proxy | a proxy | |
| Return | osid.topology.TopologyTraversalSession | a TopologyTraversalSession | |
| Errors | NOT_FOUND | no Graph found by the given Id | |
| NULL_ARGUMENT | graphId or proxy is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsTopologyTraversal() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsTopologyTraversal()
and supportsVisibleFederation() are true | |
| Method | getTopologyRoutingSession | ||
| Description |
Gets the | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy |
| Return | osid.topology.TopologyRoutingSession | a TopologyRoutingSession | |
| Errors | NULL_ARGUMENT | proxy is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsTopologyRouting() is false | ||
| Compliance | optional | This method must be implemented if supportsTopologyRouting()
is true. | |
| Method | getTopologyRoutingForGraph | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | graphId | the Id of the graph |
osid.proxy.Proxy | proxy | a proxy | |
| Return | osid.topology.TopologyRoutingSession | a TopologyRoutingSession | |
| Errors | NOT_FOUND | no Graph found by the given Id | |
| NULL_ARGUMENT | graphId or proxy is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsTopologyRouting() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsTopologyRouting()
and supportsVisibleFederation() are true | |
| Method | getNodeLookupSession | ||
| Description |
Gets the | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy |
| Return | osid.topology.NodeLookupSession | a NodeLookupSession | |
| Errors | NULL_ARGUMENT | proxy is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsNodeLookup() is false | ||
| Compliance | optional | This method must be implemented if supportsNodeLookup() is
true. | |
| Method | getNodeLookupSessionForGraph | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | graphId | the Id of the graph |
osid.proxy.Proxy | proxy | a proxy | |
| Return | osid.topology.NodeLookupSession | a NodeLookupSession | |
| Errors | NOT_FOUND | no Graph found by the given Id | |
| NULL_ARGUMENT | graphId or proxy is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsNodeLookup() or supportsVisibleFederation()
is false | ||
| Compliance | optional | This method must be implemented if supportsNodeLookup() and
supportsVisibleFederation() are true | |
| Method | getNodeQuerySession | ||
| Description |
Gets the | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy |
| Return | osid.topology.NodeQuerySession | a NodeQuerySession | |
| Errors | NULL_ARGUMENT | proxy is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsNodeQuery() is false | ||
| Compliance | optional | This method must be implemented if supportsNodeQuery() is
true. | |
| Method | getNodeQuerySessionForGraph | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | graphId | the Id of the graph |
osid.proxy.Proxy | proxy | a proxy | |
| Return | osid.topology.NodeQuerySession | a NodeQuerySession | |
| Errors | NOT_FOUND | no Graph found by the given Id | |
| NULL_ARGUMENT | graphId or proxy is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsNodeQuery() or supportsVisibleFederation()
is false | ||
| Compliance | optional | This method must be implemented if supportsNodeQuery() and
supportsVisibleFederation() are true | |
| Method | getNodeSearchSession | ||
| Description |
Gets the | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy |
| Return | osid.topology.NodeSearchSession | a NodeSearchSession | |
| Errors | NULL_ARGUMENT | proxy is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsNodeSearch() is false | ||
| Compliance | optional | This method must be implemented if supportsNodeSearch() is
true. | |
| Method | getNodeSearchSessionForGraph | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | graphId | the Id of the Graph |
osid.proxy.Proxy | proxy | a proxy | |
| Return | osid.topology.NodeSearchSession | a NodeSearchSession | |
| Errors | NOT_FOUND | no graph found by the given Id | |
| NULL_ARGUMENT | graphId or proxy is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsNodeSearch() or supportsVisibleFederation()
is false | ||
| Compliance | optional | This method must be implemented if supportsNodeSearch() and
supportsVisibleFederation() are true | |
| Method | getNodeAdminSession | ||
| Description |
Gets the | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy |
| Return | osid.topology.NodeAdminSession | a NodeAdminSession | |
| Errors | NULL_ARGUMENT | proxy is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsNodeAdmin() is false | ||
| Compliance | optional | This method must be implemented if supportsNodeAdmin() is
true. | |
| Method | getNodeAdminSessionForGraph | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | graphId | the Id of the Graph |
osid.proxy.Proxy | proxy | a proxy | |
| Return | osid.topology.NodeAdminSession | a NodeAdminSession | |
| Errors | NOT_FOUND | no graph found by the given Id | |
| NULL_ARGUMENT | graphId or proxy is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsNodeAdmin() or supportsVisibleFederation()
is false | ||
| Compliance | optional | This method must be implemented if supportsNodeAdmin() and
supportsVisibleFederation() are true | |
| Method | getNodeNotificationSession | ||
| Description |
Gets the | ||
| Parameters | osid.topology.NodeReceiver | nodeReceiver | the notification callback |
osid.proxy.Proxy | proxy | a proxy | |
| Return | osid.topology.NodeNotificationSession | a NodeNotificationSession | |
| Errors | NULL_ARGUMENT | nodeReceiver or proxy is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsNodeNotification() is false | ||
| Compliance | optional | This method must be implemented if supportsNodeNotification()
is true. | |
| Method | getNodeNotificationSessionForGraph | ||
| Description |
Gets the | ||
| Parameters | osid.topology.NodeReceiver | nodeReceiver | the notification callback |
osid.id.Id | graphId | the Id of the Graph | |
osid.proxy.Proxy | proxy | a proxy | |
| Return | osid.topology.NodeNotificationSession | a NodeNotificationSession | |
| Errors | NOT_FOUND | no graph found by the given Id | |
| NULL_ARGUMENT | nodeReceiver, graphId or proxy is null
| ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsNodeNotification() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsNodeNotification()
and supportsVisibleFederation() are true | |
| Method | getNodeGraphSession | ||
| Description |
Gets the | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy |
| Return | osid.topology.NodeGraphSession | a NodeGraphSession | |
| Errors | NULL_ARGUMENT | proxy is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsNodeGraph() is false | ||
| Compliance | optional | This method must be implemented if supportsNodeGraph() is
true. | |
| Method | getNodeGraphAssignmentSession | ||
| Description |
Gets the | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy |
| Return | osid.topology.NodeGraphAssignmentSession | a NodeGraphAssignmentSession | |
| Errors | NULL_ARGUMENT | proxy is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsNodeGraphAssignment() is false | ||
| Compliance | optional | This method must be implemented if supportsNodeGraphAssignment()
is true. | |
| Method | getNodeSmartGraphSession | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | graphId | the Id of the Graph |
osid.proxy.Proxy | proxy | a proxy | |
| Return | osid.topology.NodeSmartGraphSession | a NodeSmartGraphSession | |
| Errors | NOT_FOUND | no graph found by the given Id | |
| NULL_ARGUMENT | graphId or proxy is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsNodeSmartGraph() is false | ||
| Compliance | optional | This method must be implemented if supportsNodeSmartGraph()
is true. | |
| Method | getEdgeLookupSession | ||
| Description |
Gets the | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy |
| Return | osid.topology.EdgeLookupSession | an EdgeLookupSession | |
| Errors | NULL_ARGUMENT | proxy is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsEdgeLookup() is false | ||
| Compliance | optional | This method must be implemented if supportsEdgeLookup() is
true. | |
| Method | getEdgeLookupSessionForGraph | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | graphId | the Id of the Graph |
osid.proxy.Proxy | proxy | a proxy | |
| Return | osid.topology.EdgeLookupSession | an EdgeLookupSession | |
| Errors | NOT_FOUND | no Graph found by the given Id | |
| NULL_ARGUMENT | graphId or proxy is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsEdgeLookup() or supportsVisibleFederation()
is false | ||
| Compliance | optional | This method must be implemented if supportsEdgeLookup() and
supportsVisibleFederation() are true | |
| Method | getEdgeQuerySession | ||
| Description |
Gets the | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy |
| Return | osid.topology.EdgeQuerySession | an EdgeQuerySession | |
| Errors | NULL_ARGUMENT | proxy is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsEdgeQuery() is false | ||
| Compliance | optional | This method must be implemented if supportsEdgeQuery() is
true. | |
| Method | getEdgeQuerySessionForGraph | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | graphId | the Id of the graph |
osid.proxy.Proxy | proxy | a proxy | |
| Return | osid.topology.EdgeQuerySession | an EdgeQuerySession | |
| Errors | NOT_FOUND | no Graph found by the given Id | |
| NULL_ARGUMENT | graphId or proxy is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsEdgeQuery() or supportsVisibleFederation()
is false | ||
| Compliance | optional | This method must be implemented if supportsEdgeQuery() and
supportsVisibleFederation() are true | |
| Method | getEdgeSearchSession | ||
| Description |
Gets the | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy |
| Return | osid.topology.EdgeSearchSession | an EdgeSearchSession | |
| Errors | NULL_ARGUMENT | proxy is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsEdgeSearch() is false | ||
| Compliance | optional | This method must be implemented if supportsEdgeSearch() is
true. | |
| Method | getEdgeSearchSessionForGraph | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | graphId | the Id of the Graph |
osid.proxy.Proxy | proxy | a proxy | |
| Return | osid.topology.EdgeSearchSession | an EdgeSearchSession | |
| Errors | NOT_FOUND | no graph found by the given Id | |
| NULL_ARGUMENT | graphId or proxy is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsEdgeSearch() or supportsVisibleFederation()
is false | ||
| Compliance | optional | This method must be implemented if supportsEdgeSearch() and
supportsVisibleFederation() are true | |
| Method | getEdgeAdminSession | ||
| Description |
Gets the | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy |
| Return | osid.topology.EdgeAdminSession | an EdgeAdminSession | |
| Errors | NULL_ARGUMENT | proxy is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsEdgeAdmin() is false | ||
| Compliance | optional | This method must be implemented if supportsEdgeAdmin() is
true. | |
| Method | getEdgeAdminSessionForGraph | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | graphId | the Id of the Graph |
osid.proxy.Proxy | proxy | a proxy | |
| Return | osid.topology.EdgeAdminSession | an EdgeAdminSession | |
| Errors | NOT_FOUND | no graph found by the given Id | |
| NULL_ARGUMENT | graphId or proxy is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsEdgeAdmin() or supportsVisibleFederation()
is false | ||
| Compliance | optional | This method must be implemented if supportsEdgeAdmin() and
supportsVisibleFederation() are true | |
| Method | getEdgeNotificationSession | ||
| Description |
Gets the | ||
| Parameters | osid.topology.EdgeReceiver | edgeReceiver | the notification callback |
osid.proxy.Proxy | proxy | a proxy | |
| Return | osid.topology.EdgeNotificationSession | an EdgeNotificationSession | |
| Errors | NULL_ARGUMENT | edgeReceiver or proxy is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsEdgeNotification() is false | ||
| Compliance | optional | This method must be implemented if supportsEdgeNotification()
is true. | |
| Method | getEdgeNotificationSessionForGraph | ||
| Description |
Gets the | ||
| Parameters | osid.topology.EdgeReceiver | edgeReceiver | the notification callback |
osid.id.Id | graphId | the Id of the Graph | |
osid.proxy.Proxy | proxy | a proxy | |
| Return | osid.topology.EdgeNotificationSession | an EdgeNotificationSession | |
| Errors | NOT_FOUND | no graph found by the given Id | |
| NULL_ARGUMENT | edgeReceiver, graphId or proxy is null
| ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsEdgeNotification() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsEdgeNotification()
and supportsVisibleFederation() are true | |
| Method | getEdgeGraphSession | ||
| Description |
Gets the | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy |
| Return | osid.topology.EdgeGraphSession | an EdgeGraphSession | |
| Errors | NULL_ARGUMENT | proxy is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsEdgeGraph() is false | ||
| Compliance | optional | This method must be implemented if supportsEdgeGraph() is
true. | |
| Method | getEdgeGraphAssignmentSession | ||
| Description |
Gets the | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy |
| Return | osid.topology.EdgeGraphAssignmentSession | an EdgeGraphAssignmentSession | |
| Errors | NULL_ARGUMENT | proxy is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsEdgeGraphAssignment() is false | ||
| Compliance | optional | This method must be implemented if supportsEdgeGraphAssignment()
is true. | |
| Method | getEdgeSmartGraphSession | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | graphId | the Id of the Graph |
osid.proxy.Proxy | proxy | a proxy | |
| Return | osid.topology.EdgeSmartGraphSession | an EdgeSmartGraphSession | |
| Errors | NOT_FOUND | no graph found by the given Id | |
| NULL_ARGUMENT | graphId or proxy is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsEdgeSmartGraph() is false | ||
| Compliance | optional | This method must be implemented if supportsEdgeSmartGraph()
is true. | |
| Method | getGraphLookupSession | ||
| Description |
Gets the | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy |
| Return | osid.topology.GraphLookupSession | a GraphLookupSession | |
| Errors | NULL_ARGUMENT | proxy is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsGraphLookup() is false | ||
| Compliance | optional | This method must be implemented if supportsGraphLookup() is
true. | |
| Method | getGraphQuerySession | ||
| Description |
Gets the | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy |
| Return | osid.topology.GraphQuerySession | a GraphQuerySession | |
| Errors | NULL_ARGUMENT | proxy is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsGraphQuery() is false | ||
| Compliance | optional | This method must be implemented if supportsFamilQuery() is
true. | |
| Method | getGraphSearchSession | ||
| Description |
Gets the | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy |
| Return | osid.topology.GraphSearchSession | a GraphSearchSession | |
| Errors | NULL_ARGUMENT | proxy is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsGraphSearch() is false | ||
| Compliance | optional | This method must be implemented if supportsGraphSearch() is
true. | |
| Method | getGraphAdminSession | ||
| Description |
Gets the | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy |
| Return | osid.topology.GraphAdminSession | a GraphAdminSession | |
| Errors | NULL_ARGUMENT | proxy is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsGraphAdmin() is false | ||
| Compliance | optional | This method must be implemented if supportsGraphAdmin() is
true. | |
| Method | getGraphNotificationSession | ||
| Description |
Gets the | ||
| Parameters | osid.topology.GraphReceiver | graphReceiver | the notification callback |
osid.proxy.Proxy | proxy | a proxy | |
| Return | osid.topology.GraphNotificationSession | a GraphNotificationSession | |
| Errors | NULL_ARGUMENT | graphReceiver or proxy is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsGraphNotification() is false | ||
| Compliance | optional | This method must be implemented if supportsGraphNotification()
is true. | |
| Method | getGraphHierarchySession | ||
| Description |
Gets the | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy |
| Return | osid.topology.GraphHierarchySession | a GraphHierarchySession for graphs | |
| Errors | NULL_ARGUMENT | proxy is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsGraphHierarchy() is false | ||
| Compliance | optional | This method must be implemented if supportsGraphHierarchy()
is true. | |
| Method | getGraphHierarchyDesignSession | ||
| Description |
Gets the | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy |
| Return | osid.topology.GraphHierarchyDesignSession | a HierarchyDesignSession for graphs | |
| Errors | NULL_ARGUMENT | proxy is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsGraphHierarchyDesign() is false | ||
| Compliance | optional | This method must be implemented if supportsGraphHierarchyDesign()
is true. | |
| Method | getTopologyBatchProxyManager | ||
| Description |
Gets a | ||
| Return | osid.topology.batch.TopologyBatchProxyManager | a TopologyBatchProxyManager | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsTopologyBatch() is false | ||
| Compliance | optional | This method must be implemented if supportsTopologyBatch()
is true. | |
| Method | getTopologyPathProxyManager | ||
| Description |
Gets a | ||
| Return | osid.topology.path.TopologyPathProxyManager | a TopologyPathProxyManager | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsTopologyPath() is false | ||
| Compliance | optional | This method must be implemented if supportsTopologyPath() is
true. | |
| Method | getTopologyRulesProxyManager | ||
| Description |
Gets a | ||
| Return | osid.topology.rules.TopologyRulesProxyManager | a TopologyRulesProxyManager | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsTopologyRules() is false | ||
| Compliance | optional | This method must be implemented if supportsTopologyRules()
is true. | |