OSID Logo
OSID Specifications
topology package
Version 3.1.0
Interfaceosid.topology.TopologyProxyManager
Implementsosid.OsidProxyManager
osid.topology.TopologyProfile
Used Byosid.orchestration.OrchestrationManager
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 Proxy for passing information from server environments.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
MethodgetTopologyTraversalSession
Description

Gets the OsidSession associated with the topology traversal service.

Parametersosid.proxy.Proxyproxy a proxy
Returnosid.topology.TopologyTraversalSession a TopologyTraversalSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsTopologyTraversal() is false
Complianceoptional This method must be implemented if supportsTopologyTraversal() is true.
MethodgetTopologyTraversalForGraph
Description

Gets the OsidSession associated with the topology traversal service for the given graph.

Parametersosid.id.IdgraphId the Id of the graph
osid.proxy.Proxyproxy a proxy
Returnosid.topology.TopologyTraversalSession a TopologyTraversalSession
ErrorsNOT_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
Complianceoptional This method must be implemented if supportsTopologyTraversal() and supportsVisibleFederation() are true
MethodgetTopologyRoutingSession
Description

Gets the OsidSession associated with the topology routing service.

Parametersosid.proxy.Proxyproxy a proxy
Returnosid.topology.TopologyRoutingSession a TopologyRoutingSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsTopologyRouting() is false
Complianceoptional This method must be implemented if supportsTopologyRouting() is true.
MethodgetTopologyRoutingForGraph
Description

Gets the OsidSession associated with the topology routing service for the given graph.

Parametersosid.id.IdgraphId the Id of the graph
osid.proxy.Proxyproxy a proxy
Returnosid.topology.TopologyRoutingSession a TopologyRoutingSession
ErrorsNOT_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
Complianceoptional This method must be implemented if supportsTopologyRouting() and supportsVisibleFederation() are true
MethodgetNodeLookupSession
Description

Gets the OsidSession associated with the node lookup service.

Parametersosid.proxy.Proxyproxy a proxy
Returnosid.topology.NodeLookupSession a NodeLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsNodeLookup() is false
Complianceoptional This method must be implemented if supportsNodeLookup() is true.
MethodgetNodeLookupSessionForGraph
Description

Gets the OsidSession associated with the node lookup service for the given graph.

Parametersosid.id.IdgraphId the Id of the graph
osid.proxy.Proxyproxy a proxy
Returnosid.topology.NodeLookupSession a NodeLookupSession
ErrorsNOT_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
Complianceoptional This method must be implemented if supportsNodeLookup() and supportsVisibleFederation() are true
MethodgetNodeQuerySession
Description

Gets the OsidSession associated with the node query service.

Parametersosid.proxy.Proxyproxy a proxy
Returnosid.topology.NodeQuerySession a NodeQuerySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsNodeQuery() is false
Complianceoptional This method must be implemented if supportsNodeQuery() is true.
MethodgetNodeQuerySessionForGraph
Description

Gets the OsidSession associated with the node query service for the given graph.

Parametersosid.id.IdgraphId the Id of the graph
osid.proxy.Proxyproxy a proxy
Returnosid.topology.NodeQuerySession a NodeQuerySession
ErrorsNOT_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
Complianceoptional This method must be implemented if supportsNodeQuery() and supportsVisibleFederation() are true
MethodgetNodeSearchSession
Description

Gets the OsidSession associated with the node search service.

Parametersosid.proxy.Proxyproxy a proxy
Returnosid.topology.NodeSearchSession a NodeSearchSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsNodeSearch() is false
Complianceoptional This method must be implemented if supportsNodeSearch() is true.
MethodgetNodeSearchSessionForGraph
Description

Gets the OsidSession associated with the node search service for the given graph.

Parametersosid.id.IdgraphId the Id of the Graph
osid.proxy.Proxyproxy a proxy
Returnosid.topology.NodeSearchSession a NodeSearchSession
ErrorsNOT_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
Complianceoptional This method must be implemented if supportsNodeSearch() and supportsVisibleFederation() are true
MethodgetNodeAdminSession
Description

Gets the OsidSession associated with the node administration service.

Parametersosid.proxy.Proxyproxy a proxy
Returnosid.topology.NodeAdminSession a NodeAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsNodeAdmin() is false
Complianceoptional This method must be implemented if supportsNodeAdmin() is true.
MethodgetNodeAdminSessionForGraph
Description

Gets the OsidSession associated with the node administration service for the given graph.

Parametersosid.id.IdgraphId the Id of the Graph
osid.proxy.Proxyproxy a proxy
Returnosid.topology.NodeAdminSession a NodeAdminSession
ErrorsNOT_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
Complianceoptional This method must be implemented if supportsNodeAdmin() and supportsVisibleFederation() are true
MethodgetNodeNotificationSession
Description

Gets the OsidSession associated with the node notification service.

Parametersosid.topology.NodeReceivernodeReceiver the notification callback
osid.proxy.Proxyproxy a proxy
Returnosid.topology.NodeNotificationSession a NodeNotificationSession
ErrorsNULL_ARGUMENT nodeReceiver or proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsNodeNotification() is false
Complianceoptional This method must be implemented if supportsNodeNotification() is true.
MethodgetNodeNotificationSessionForGraph
Description

Gets the OsidSession associated with the node notification service for the given graph.

Parametersosid.topology.NodeReceivernodeReceiver the notification callback
osid.id.IdgraphId the Id of the Graph
osid.proxy.Proxyproxy a proxy
Returnosid.topology.NodeNotificationSession a NodeNotificationSession
ErrorsNOT_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
Complianceoptional This method must be implemented if supportsNodeNotification() and supportsVisibleFederation() are true
MethodgetNodeGraphSession
Description

Gets the OsidSession to lookup node/graph mappings.

Parametersosid.proxy.Proxyproxy a proxy
Returnosid.topology.NodeGraphSession a NodeGraphSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsNodeGraph() is false
Complianceoptional This method must be implemented if supportsNodeGraph() is true.
MethodgetNodeGraphAssignmentSession
Description

Gets the OsidSession associated with assigning nodes to graphs.

Parametersosid.proxy.Proxyproxy a proxy
Returnosid.topology.NodeGraphAssignmentSession a NodeGraphAssignmentSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsNodeGraphAssignment() is false
Complianceoptional This method must be implemented if supportsNodeGraphAssignment() is true.
MethodgetNodeSmartGraphSession
Description

Gets the OsidSession to manage dynamic graphs of retlationships.

Parametersosid.id.IdgraphId the Id of the Graph
osid.proxy.Proxyproxy a proxy
Returnosid.topology.NodeSmartGraphSession a NodeSmartGraphSession
ErrorsNOT_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
Complianceoptional This method must be implemented if supportsNodeSmartGraph() is true.
MethodgetEdgeLookupSession
Description

Gets the OsidSession associated with the edge lookup service.

Parametersosid.proxy.Proxyproxy a proxy
Returnosid.topology.EdgeLookupSession an EdgeLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsEdgeLookup() is false
Complianceoptional This method must be implemented if supportsEdgeLookup() is true.
MethodgetEdgeLookupSessionForGraph
Description

Gets the OsidSession associated with the edge lookup service for the given graph.

Parametersosid.id.IdgraphId the Id of the Graph
osid.proxy.Proxyproxy a proxy
Returnosid.topology.EdgeLookupSession an EdgeLookupSession
ErrorsNOT_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
Complianceoptional This method must be implemented if supportsEdgeLookup() and supportsVisibleFederation() are true
MethodgetEdgeQuerySession
Description

Gets the OsidSession associated with the edge query service.

Parametersosid.proxy.Proxyproxy a proxy
Returnosid.topology.EdgeQuerySession an EdgeQuerySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsEdgeQuery() is false
Complianceoptional This method must be implemented if supportsEdgeQuery() is true.
MethodgetEdgeQuerySessionForGraph
Description

Gets the OsidSession associated with the edge query service for the given graph.

Parametersosid.id.IdgraphId the Id of the graph
osid.proxy.Proxyproxy a proxy
Returnosid.topology.EdgeQuerySession an EdgeQuerySession
ErrorsNOT_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
Complianceoptional This method must be implemented if supportsEdgeQuery() and supportsVisibleFederation() are true
MethodgetEdgeSearchSession
Description

Gets the OsidSession associated with the edge search service.

Parametersosid.proxy.Proxyproxy a proxy
Returnosid.topology.EdgeSearchSession an EdgeSearchSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsEdgeSearch() is false
Complianceoptional This method must be implemented if supportsEdgeSearch() is true.
MethodgetEdgeSearchSessionForGraph
Description

Gets the OsidSession associated with the edge search service for the given graph.

Parametersosid.id.IdgraphId the Id of the Graph
osid.proxy.Proxyproxy a proxy
Returnosid.topology.EdgeSearchSession an EdgeSearchSession
ErrorsNOT_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
Complianceoptional This method must be implemented if supportsEdgeSearch() and supportsVisibleFederation() are true
MethodgetEdgeAdminSession
Description

Gets the OsidSession associated with the edge administration service.

Parametersosid.proxy.Proxyproxy a proxy
Returnosid.topology.EdgeAdminSession an EdgeAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsEdgeAdmin() is false
Complianceoptional This method must be implemented if supportsEdgeAdmin() is true.
MethodgetEdgeAdminSessionForGraph
Description

Gets the OsidSession associated with the edge administration service for the given graph.

Parametersosid.id.IdgraphId the Id of the Graph
osid.proxy.Proxyproxy a proxy
Returnosid.topology.EdgeAdminSession an EdgeAdminSession
ErrorsNOT_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
Complianceoptional This method must be implemented if supportsEdgeAdmin() and supportsVisibleFederation() are true
MethodgetEdgeNotificationSession
Description

Gets the OsidSession associated with the edge notification service.

Parametersosid.topology.EdgeReceiveredgeReceiver the notification callback
osid.proxy.Proxyproxy a proxy
Returnosid.topology.EdgeNotificationSession an EdgeNotificationSession
ErrorsNULL_ARGUMENT edgeReceiver or proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsEdgeNotification() is false
Complianceoptional This method must be implemented if supportsEdgeNotification() is true.
MethodgetEdgeNotificationSessionForGraph
Description

Gets the OsidSession associated with the edge notification service for the given graph.

Parametersosid.topology.EdgeReceiveredgeReceiver the notification callback
osid.id.IdgraphId the Id of the Graph
osid.proxy.Proxyproxy a proxy
Returnosid.topology.EdgeNotificationSession an EdgeNotificationSession
ErrorsNOT_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
Complianceoptional This method must be implemented if supportsEdgeNotification() and supportsVisibleFederation() are true
MethodgetEdgeGraphSession
Description

Gets the OsidSession to lookup edge/graph mappings.

Parametersosid.proxy.Proxyproxy a proxy
Returnosid.topology.EdgeGraphSession an EdgeGraphSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsEdgeGraph() is false
Complianceoptional This method must be implemented if supportsEdgeGraph() is true.
MethodgetEdgeGraphAssignmentSession
Description

Gets the OsidSession associated with assigning edges to graphs.

Parametersosid.proxy.Proxyproxy a proxy
Returnosid.topology.EdgeGraphAssignmentSession an EdgeGraphAssignmentSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsEdgeGraphAssignment() is false
Complianceoptional This method must be implemented if supportsEdgeGraphAssignment() is true.
MethodgetEdgeSmartGraphSession
Description

Gets the OsidSession to manage dynamic graphs of retlationships.

Parametersosid.id.IdgraphId the Id of the Graph
osid.proxy.Proxyproxy a proxy
Returnosid.topology.EdgeSmartGraphSession an EdgeSmartGraphSession
ErrorsNOT_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
Complianceoptional This method must be implemented if supportsEdgeSmartGraph() is true.
MethodgetGraphLookupSession
Description

Gets the OsidSession associated with the graph lookup service.

Parametersosid.proxy.Proxyproxy a proxy
Returnosid.topology.GraphLookupSession a GraphLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsGraphLookup() is false
Complianceoptional This method must be implemented if supportsGraphLookup() is true.
MethodgetGraphQuerySession
Description

Gets the OsidSession associated with the graph query service.

Parametersosid.proxy.Proxyproxy a proxy
Returnosid.topology.GraphQuerySession a GraphQuerySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsGraphQuery() is false
Complianceoptional This method must be implemented if supportsFamilQuery() is true.
MethodgetGraphSearchSession
Description

Gets the OsidSession associated with the graph search service.

Parametersosid.proxy.Proxyproxy a proxy
Returnosid.topology.GraphSearchSession a GraphSearchSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsGraphSearch() is false
Complianceoptional This method must be implemented if supportsGraphSearch() is true.
MethodgetGraphAdminSession
Description

Gets the OsidSession associated with the graph administrative service.

Parametersosid.proxy.Proxyproxy a proxy
Returnosid.topology.GraphAdminSession a GraphAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsGraphAdmin() is false
Complianceoptional This method must be implemented if supportsGraphAdmin() is true.
MethodgetGraphNotificationSession
Description

Gets the OsidSession associated with the graph notification service.

Parametersosid.topology.GraphReceivergraphReceiver the notification callback
osid.proxy.Proxyproxy a proxy
Returnosid.topology.GraphNotificationSession a GraphNotificationSession
ErrorsNULL_ARGUMENT graphReceiver or proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsGraphNotification() is false
Complianceoptional This method must be implemented if supportsGraphNotification() is true.
MethodgetGraphHierarchySession
Description

Gets the OsidSession associated with the graph hierarchy service.

Parametersosid.proxy.Proxyproxy a proxy
Returnosid.topology.GraphHierarchySession a GraphHierarchySession for graphs
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsGraphHierarchy() is false
Complianceoptional This method must be implemented if supportsGraphHierarchy() is true.
MethodgetGraphHierarchyDesignSession
Description

Gets the OsidSession associated with the graph hierarchy design service.

Parametersosid.proxy.Proxyproxy a proxy
Returnosid.topology.GraphHierarchyDesignSession a HierarchyDesignSession for graphs
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsGraphHierarchyDesign() is false
Complianceoptional This method must be implemented if supportsGraphHierarchyDesign() is true.
MethodgetTopologyBatchProxyManager
Description

Gets a TopologyBatchManager.

Returnosid.topology.batch.TopologyBatchProxyManager a TopologyBatchProxyManager
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsTopologyBatch() is false
Complianceoptional This method must be implemented if supportsTopologyBatch() is true.
MethodgetTopologyPathProxyManager
Description

Gets a TopologyPathManager.

Returnosid.topology.path.TopologyPathProxyManager a TopologyPathProxyManager
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsTopologyPath() is false
Complianceoptional This method must be implemented if supportsTopologyPath() is true.
MethodgetTopologyRulesProxyManager
Description

Gets a TopologyRulesManager.

Returnosid.topology.rules.TopologyRulesProxyManager a TopologyRulesProxyManager
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsTopologyRules() is false
Complianceoptional This method must be implemented if supportsTopologyRules() is true.