OSID - osid.topology.TopologyManager Service Interface Definition

Interface	osid.topology.TopologyManager
Implements	`osid.OsidManager`
Implements	`osid.topology.TopologyProfile`
Description	The topology manager provides access to topology sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are: `TopologyTraversalSession:` a session to traverse topologies `TopologyRoutingSession:` a session get routes through topologies `NodeLookupSession:` a session to retrieve nodes `NodeQuerySession:` a session to query nodes `NodeSearchSession:` a session to search for nodes `NodeAdminSession:` a session to create and delete nodes `NodeNotificationSession:` a session to receive notifications pertaining to node changes `NodeGraphSession:` a session to look up node to graph mappings `NodeGraphAssignmentSession:` a session to manage node to graph mappings `NodeSmartGraphSession:` a session to manage smart graphs of nodes `EdgeLookupSession:` a session to retrieve edges EdgeQuerySession: a session to query edges `EdgeSearchSession:` a session to search for edges `EdgeAdminSession:` a session to create and delete edges `EdgeNotificationSession:` a session to receive notifications pertaining to edge changes `EdgeGraphSession:` a session to looking mappings of edges to graphs `EdgeGraphAssignmentSession:` a session to manage edge to graph mappings `EdgeSmartGraphSession:` a session to manage smart graphs of edges `GraphLookupSession:` a session to retrieve graphs `GraphQuerySession:` a session to query for graphs `GraphSearchSession:` a session to search for graphs `GraphAdminSession:` a session to create and delete graphs `GraphNotificationSession:` a session to receive notifications pertaining to graph changes `GraphHierarchySession:` a session to traverse a hierarchy of graph `GraphHierarchyDesignSession:` a session to manage a graph hierarchy
Method	getTopologyTraversalSession
Description	Gets the `OsidSession` associated with the topology traversal service.
Return	`osid.topology.TopologyTraversalSession`		a `TopologyTraversalSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsTopologyTraversal()` is `false`
Compliance	`optional`		This method must be implemented if `supportsTopologyTraversal()` is `true.`
Method	getTopologyTraversalForGraph
Description	Gets the `OsidSession` associated with the topology traversal service for the given graph.
Parameters	`osid.id.Id`	`graphId`	the `Id` of the graph
Return	`osid.topology.TopologyTraversalSession`		a `TopologyTraversalSession`
Errors	NOT_FOUND		no `Graph` found by the given `Id`
	NULL_ARGUMENT		`graphId` 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 `OsidSession` associated with the topology routing service.
Return	`osid.topology.TopologyRoutingSession`		a `TopologyRoutingSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsTopologyRouting()` is `false`
Compliance	`optional`		This method must be implemented if `supportsTopologyRouting()` is `true.`
Method	getTopologyRoutingForGraph
Description	Gets the `OsidSession` associated with the topology routing service for the given graph.
Parameters	`osid.id.Id`	`graphId`	the `Id` of the graph
Return	`osid.topology.TopologyRoutingSession`		a `TopologyRoutingSession`
Errors	NOT_FOUND		no `Graph` found by the given `Id`
	NULL_ARGUMENT		`graphId` 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 `OsidSession` associated with the node lookup service.
Return	`osid.topology.NodeLookupSession`		a `NodeLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsNodeLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsNodeLookup()` is `true.`
Method	getNodeLookupSessionForGraph
Description	Gets the `OsidSession` associated with the node lookup service for the given graph.
Parameters	`osid.id.Id`	`graphId`	the `Id` of the graph
Return	`osid.topology.NodeLookupSession`		a `NodeLookupSession`
Errors	NOT_FOUND		no `Graph` found by the given `Id`
	NULL_ARGUMENT		`graphId` 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 `OsidSession` associated with the node query service.
Return	`osid.topology.NodeQuerySession`		a `NodeQuerySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsNodeQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsNodeQuery()` is `true.`
Method	getNodeQuerySessionForGraph
Description	Gets the `OsidSession` associated with the node query service for the given graph.
Parameters	`osid.id.Id`	`graphId`	the `Id` of the graph
Return	`osid.topology.NodeQuerySession`		a `NodeQuerySession`
Errors	NOT_FOUND		no `Graph` found by the given `Id`
	NULL_ARGUMENT		`graphId` 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 `OsidSession` associated with the node search service.
Return	`osid.topology.NodeSearchSession`		a `NodeSearchSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsNodeSearch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsNodeSearch()` is `true.`
Method	getNodeSearchSessionForGraph
Description	Gets the `OsidSession` associated with the node search service for the given graph.
Parameters	`osid.id.Id`	`graphId`	the `Id` of the `Graph`
Return	`osid.topology.NodeSearchSession`		a `NodeSearchSession`
Errors	NOT_FOUND		no graph found by the given `Id`
	NULL_ARGUMENT		`graphId` 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 `OsidSession` associated with the node administration service.
Return	`osid.topology.NodeAdminSession`		a `NodeAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsNodeAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsNodeAdmin()` is `true.`
Method	getNodeAdminSessionForGraph
Description	Gets the `OsidSession` associated with the node administration service for the given graph.
Parameters	`osid.id.Id`	`graphId`	the `Id` of the `Graph`
Return	`osid.topology.NodeAdminSession`		a `NodeAdminSession`
Errors	NOT_FOUND		no graph found by the given `Id`
	NULL_ARGUMENT		`graphId` 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 `OsidSession` associated with the node notification service.
Parameters	`osid.topology.NodeReceiver`	`nodeReceiver`	the notification callback
Return	`osid.topology.NodeNotificationSession`		a `NodeNotificationSession`
Errors	NULL_ARGUMENT		`nodeReceiver` 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 `OsidSession` associated with the node notification service for the given graph.
Parameters	`osid.topology.NodeReceiver`	`nodeReceiver`	the notification callback
Parameters	`osid.id.Id`	`graphId`	the `Id` of the `Graph`
Return	`osid.topology.NodeNotificationSession`		a `NodeNotificationSession`
Errors	NOT_FOUND		no graph found by the given `Id`
	NULL_ARGUMENT		`nodeReceiver` or `graphId` 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 `OsidSession` to lookup node/graph mappings.
Return	`osid.topology.NodeGraphSession`		a `NodeGraphSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsNodeGraph()` is `false`
Compliance	`optional`		This method must be implemented if `supportsNodeGraph()` is `true.`
Method	getNodeGraphAssignmentSession
Description	Gets the `OsidSession` associated with assigning nodes to graphs.
Return	`osid.topology.NodeGraphAssignmentSession`		a `NodeGraphAssignmentSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsNodeGraphAssignment()` is `false`
Compliance	`optional`		This method must be implemented if `supportsNodeGraphAssignment()` is `true.`
Method	getNodeSmartGraphSession
Description	Gets the `OsidSession` to manage dynamic graphs of retlationships.
Parameters	`osid.id.Id`	`graphId`	the `Id` of the `Graph`
Return	`osid.topology.NodeSmartGraphSession`		a `NodeSmartGraphSession`
Errors	NOT_FOUND		no graph found by the given `Id`
	NULL_ARGUMENT		`graphId` 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 `OsidSession` associated with the edge lookup service.
Return	`osid.topology.EdgeLookupSession`		an `EdgeLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsEdgeLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsEdgeLookup()` is `true.`
Method	getEdgeLookupSessionForGraph
Description	Gets the `OsidSession` associated with the edge lookup service for the given graph.
Parameters	`osid.id.Id`	`graphId`	the `Id` of the `Graph`
Return	`osid.topology.EdgeLookupSession`		an `EdgeLookupSession`
Errors	NOT_FOUND		no `Graph` found by the given `Id`
	NULL_ARGUMENT		`graphId` 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 `OsidSession` associated with the edge query service.
Return	`osid.topology.EdgeQuerySession`		an `EdgeQuerySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsEdgeQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsEdgeQuery()` is `true.`
Method	getEdgeQuerySessionForGraph
Description	Gets the `OsidSession` associated with the edge query service for the given graph.
Parameters	`osid.id.Id`	`graphId`	the `Id` of the graph
Return	`osid.topology.EdgeQuerySession`		an `EdgeQuerySession`
Errors	NOT_FOUND		no `Graph` found by the given `Id`
	NULL_ARGUMENT		`graphId` 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 `OsidSession` associated with the edge search service.
Return	`osid.topology.EdgeSearchSession`		an `EdgeSearchSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsEdgeSearch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsEdgeSearch()` is `true.`
Method	getEdgeSearchSessionForGraph
Description	Gets the `OsidSession` associated with the edge search service for the given graph.
Parameters	`osid.id.Id`	`graphId`	the `Id` of the `Graph`
Return	`osid.topology.EdgeSearchSession`		an `EdgeSearchSession`
Errors	NOT_FOUND		no graph found by the given `Id`
	NULL_ARGUMENT		`graphId` 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 `OsidSession` associated with the edge administration service.
Return	`osid.topology.EdgeAdminSession`		an `EdgeAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsEdgeAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsEdgeAdmin()` is `true.`
Method	getEdgeAdminSessionForGraph
Description	Gets the `OsidSession` associated with the edge administration service for the given graph.
Parameters	`osid.id.Id`	`graphId`	the `Id` of the `Graph`
Return	`osid.topology.EdgeAdminSession`		an `EdgeAdminSession`
Errors	NOT_FOUND		no graph found by the given `Id`
	NULL_ARGUMENT		`graphId` 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 `OsidSession` associated with the edge notification service.
Parameters	`osid.topology.EdgeReceiver`	`edgeReceiver`	the notification callback
Return	`osid.topology.EdgeNotificationSession`		an `EdgeNotificationSession`
Errors	NULL_ARGUMENT		`edgeReceiver` 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 `OsidSession` associated with the edge notification service for the given graph.
Parameters	`osid.topology.EdgeReceiver`	`edgeReceiver`	the notification callback
Parameters	`osid.id.Id`	`graphId`	the `Id` of the `Graph`
Return	`osid.topology.EdgeNotificationSession`		an `EdgeNotificationSession`
Errors	NOT_FOUND		no graph found by the given `Id`
	NULL_ARGUMENT		`edgeReceiver` or `graphId` 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 `OsidSession` to lookup edge/graph mappings.
Return	`osid.topology.EdgeGraphSession`		an `EdgeGraphSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsEdgeGraph()` is `false`
Compliance	`optional`		This method must be implemented if `supportsEdgeGraph()` is `true.`
Method	getEdgeGraphAssignmentSession
Description	Gets the `OsidSession` associated with assigning edges to graphs.
Return	`osid.topology.EdgeGraphAssignmentSession`		an `EdgeGraphAssignmentSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsEdgeGraphAssignment()` is `false`
Compliance	`optional`		This method must be implemented if `supportsEdgeGraphAssignment()` is `true.`
Method	getEdgeSmartGraphSession
Description	Gets the `OsidSession` to manage dynamic graphs of retlationships.
Parameters	`osid.id.Id`	`graphId`	the `Id` of the `Graph`
Return	`osid.topology.EdgeSmartGraphSession`		an `EdgeSmartGraphSession`
Errors	NOT_FOUND		no graph found by the given `Id`
	NULL_ARGUMENT		`graphId` 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 `OsidSession` associated with the graph lookup service.
Return	`osid.topology.GraphLookupSession`		a `GraphLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsGraphLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsGraphLookup()` is `true.`
Method	getGraphQuerySession
Description	Gets the `OsidSession` associated with the graph query service.
Return	`osid.topology.GraphQuerySession`		a `GraphQuerySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsGraphQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsGraphQuery()` is `true.`
Method	getGraphSearchSession
Description	Gets the `OsidSession` associated with the graph search service.
Return	`osid.topology.GraphSearchSession`		a `GraphSearchSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsGraphSearch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsGraphSearch()` is `true.`
Method	getGraphAdminSession
Description	Gets the `OsidSession` associated with the graph administrative service.
Return	`osid.topology.GraphAdminSession`		a `GraphAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsGraphAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsGraphAdmin()` is `true.`
Method	getGraphNotificationSession
Description	Gets the `OsidSession` associated with the graph notification service.
Parameters	`osid.topology.GraphReceiver`	`graphReceiver`	the notification callback
Return	`osid.topology.GraphNotificationSession`		a `GraphNotificationSession`
Errors	NULL_ARGUMENT		`graphReceiver` 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 `OsidSession` associated with the graph hierarchy service.
Return	`osid.topology.GraphHierarchySession`		a `GraphHierarchySession` for graphs
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsGraphHierarchy()` is `false`
Compliance	`optional`		This method must be implemented if `supportsGraphHierarchy()` is `true.`
Method	getGraphHierarchyDesignSession
Description	Gets the `OsidSession` associated with the graph hierarchy design service.
Return	`osid.topology.GraphHierarchyDesignSession`		a `HierarchyDesignSession` for graphs
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsGraphHierarchyDesign()` is `false`
Compliance	`optional`		This method must be implemented if `supportsGraphHierarchyDesign()` is `true.`
Method	getTopologyBatchManager
Description	Gets a `TopologyBatchManager.`
Return	`osid.topology.batch.TopologyBatchManager`		a `TopologyBatchManager`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsTopologyBatch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsTopologyBatch()` is `true.`
Method	getTopologyPathManager
Description	Gets a `TopologyPathManager.`
Return	`osid.topology.path.TopologyPathManager`		a `TopologyPathManager`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsTopologyPath()` is `false`
Compliance	`optional`		This method must be implemented if `supportsTopologyPath()` is `true.`
Method	getTopologyRulesManager
Description	Gets a `TopologyRulesManager.`
Return	`osid.topology.rules.TopologyRulesManager`		a `TopologyRulesManager`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsTopologyRules()` is `false`
Compliance	`optional`		This method must be implemented if `supportsTopologyRules()` is `true.`