org.osid.topology

Interface TopologyManager

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidManager, OsidProfile, Sourceable, TopologyProfile

public interface TopologyManager
extends OsidManager, TopologyProfile

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 Summary

Methods

Modifier and Type	Method and Description
EdgeAdminSession	getEdgeAdminSession() Gets the OsidSession associated with the edge administration service.
EdgeAdminSession	getEdgeAdminSessionForGraph(Id graphId) Gets the OsidSession associated with the edge administration service for the given graph.
EdgeGraphAssignmentSession	getEdgeGraphAssignmentSession() Gets the OsidSession associated with assigning edges to graphs.
EdgeGraphSession	getEdgeGraphSession() Gets the OsidSession to lookup edge/graph mappings.
EdgeLookupSession	getEdgeLookupSession() Gets the OsidSession associated with the edge lookup service.
EdgeLookupSession	getEdgeLookupSessionForGraph(Id graphId) Gets the OsidSession associated with the edge lookup service for the given graph.
EdgeNotificationSession	getEdgeNotificationSession(EdgeReceiver edgeReceiver) Gets the OsidSession associated with the edge notification service.
EdgeNotificationSession	getEdgeNotificationSessionForGraph(EdgeReceiver edgeReceiver, Id graphId) Gets the OsidSession associated with the edge notification service for the given graph.
EdgeQuerySession	getEdgeQuerySession() Gets the OsidSession associated with the edge query service.
EdgeQuerySession	getEdgeQuerySessionForGraph(Id graphId) Gets the OsidSession associated with the edge query service for the given graph.
EdgeSearchSession	getEdgeSearchSession() Gets the OsidSession associated with the edge search service.
EdgeSearchSession	getEdgeSearchSessionForGraph(Id graphId) Gets the OsidSession associated with the edge search service for the given graph.
EdgeSmartGraphSession	getEdgeSmartGraphSession(Id graphId) Gets the OsidSession to manage dynamic graphs of retlationships.
GraphAdminSession	getGraphAdminSession() Gets the OsidSession associated with the graph administrative service.
GraphHierarchyDesignSession	getGraphHierarchyDesignSession() Gets the OsidSession associated with the graph hierarchy design service.
GraphHierarchySession	getGraphHierarchySession() Gets the OsidSession associated with the graph hierarchy service.
GraphLookupSession	getGraphLookupSession() Gets the OsidSession associated with the graph lookup service.
GraphNotificationSession	getGraphNotificationSession(GraphReceiver graphReceiver) Gets the OsidSession associated with the graph notification service.
GraphQuerySession	getGraphQuerySession() Gets the OsidSession associated with the graph query service.
GraphSearchSession	getGraphSearchSession() Gets the OsidSession associated with the graph search service.
NodeAdminSession	getNodeAdminSession() Gets the OsidSession associated with the node administration service.
NodeAdminSession	getNodeAdminSessionForGraph(Id graphId) Gets the OsidSession associated with the node administration service for the given graph.
NodeGraphAssignmentSession	getNodeGraphAssignmentSession() Gets the OsidSession associated with assigning nodes to graphs.
NodeGraphSession	getNodeGraphSession() Gets the OsidSession to lookup node/graph mappings.
NodeLookupSession	getNodeLookupSession() Gets the OsidSession associated with the node lookup service.
NodeLookupSession	getNodeLookupSessionForGraph(Id graphId) Gets the OsidSession associated with the node lookup service for the given graph.
NodeNotificationSession	getNodeNotificationSession(NodeReceiver nodeReceiver) Gets the OsidSession associated with the node notification service.
NodeNotificationSession	getNodeNotificationSessionForGraph(NodeReceiver nodeReceiver, Id graphId) Gets the OsidSession associated with the node notification service for the given graph.
NodeQuerySession	getNodeQuerySession() Gets the OsidSession associated with the node query service.
NodeQuerySession	getNodeQuerySessionForGraph(Id graphId) Gets the OsidSession associated with the node query service for the given graph.
NodeSearchSession	getNodeSearchSession() Gets the OsidSession associated with the node search service.
NodeSearchSession	getNodeSearchSessionForGraph(Id graphId) Gets the OsidSession associated with the node search service for the given graph.
NodeSmartGraphSession	getNodeSmartGraphSession(Id graphId) Gets the OsidSession to manage dynamic graphs of retlationships.
TopologyBatchManager	getTopologyBatchManager() Gets a TopologyBatchManager.
TopologyPathManager	getTopologyPathManager() Gets a TopologyPathManager.
TopologyRoutingSession	getTopologyRoutingForGraph(Id graphId) Gets the OsidSession associated with the topology routing service for the given graph.
TopologyRoutingSession	getTopologyRoutingSession() Gets the OsidSession associated with the topology routing service.
TopologyRulesManager	getTopologyRulesManager() Gets a TopologyRulesManager.
TopologyTraversalSession	getTopologyTraversalForGraph(Id graphId) Gets the OsidSession associated with the topology traversal service for the given graph.
TopologyTraversalSession	getTopologyTraversalSession() Gets the OsidSession associated with the topology traversal service.

Methods inherited from interface org.osid.OsidManager

changeBranch, initialize, rollbackService

Methods inherited from interface org.osid.binding.java.OsidManager

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.topology.TopologyProfile

getEdgeRecordTypes, getEdgeSearchRecordTypes, getGraphRecordTypes, getGraphSearchRecordTypes, getNodeRecordTypes, getNodeSearchRecordTypes, supportsEdgeAdmin, supportsEdgeGraph, supportsEdgeGraphAssignment, supportsEdgeLookup, supportsEdgeNotification, supportsEdgeRecordType, supportsEdgeSearch, supportsEdgeSearchRecordType, supportsEdgeSmartGraph, supportsGraphAdmin, supportsGraphHierarchy, supportsGraphHierarchyDesign, supportsGraphLookup, supportsGraphNotification, supportsGraphQuery, supportsGraphRecordType, supportsGraphSearch, supportsGraphSearchRecordType, supportsNodeAdmin, supportsNodeGraph, supportsNodeGraphAssignment, supportsNodeLookup, supportsNodeNotification, supportsNodeQuery, supportsNodeRecordType, supportsNodeSearch, supportsNodeSearchRecordType, supportsNodeSmartGraph, supportsTopologyBatch, supportsTopologyPath, supportsTopologyRouting, supportsTopologyRules, supportsTopologyTraversal, supportsVisibleFederation

Methods inherited from interface org.osid.OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getTopologyTraversalSession

TopologyTraversalSession getTopologyTraversalSession()
                                                     throws OperationFailedException

Gets the OsidSession associated with the topology traversal service.

Returns:

a TopologyTraversalSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsTopologyTraversal() is false

Compliance:

optional - This method must be implemented if supportsTopologyTraversal() is true.

getTopologyTraversalForGraph

TopologyTraversalSession getTopologyTraversalForGraph(Id graphId)
                                                      throws NotFoundException,
                                                             OperationFailedException

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

Parameters:

graphId - the Id of the graph

Returns:

a TopologyTraversalSession

Throws:

NotFoundException - no Graph found by the given Id

NullArgumentException - graphId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTopologyTraversal() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsTopologyTraversal() and supportsVisibleFederation() are true

getTopologyRoutingSession

TopologyRoutingSession getTopologyRoutingSession()
                                                 throws OperationFailedException

Gets the OsidSession associated with the topology routing service.

Returns:

a TopologyRoutingSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsTopologyRouting() is false

Compliance:

optional - This method must be implemented if supportsTopologyRouting() is true.

getTopologyRoutingForGraph

TopologyRoutingSession getTopologyRoutingForGraph(Id graphId)
                                                  throws NotFoundException,
                                                         OperationFailedException

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

Parameters:

graphId - the Id of the graph

Returns:

a TopologyRoutingSession

Throws:

NotFoundException - no Graph found by the given Id

NullArgumentException - graphId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTopologyRouting() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsTopologyRouting() and supportsVisibleFederation() are true

getNodeLookupSession

NodeLookupSession getNodeLookupSession()
                                       throws OperationFailedException

Gets the OsidSession associated with the node lookup service.

Returns:

a NodeLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsNodeLookup() is false

Compliance:

optional - This method must be implemented if supportsNodeLookup() is true.

getNodeLookupSessionForGraph

NodeLookupSession getNodeLookupSessionForGraph(Id graphId)
                                               throws NotFoundException,
                                                      OperationFailedException

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

Parameters:

graphId - the Id of the graph

Returns:

a NodeLookupSession

Throws:

NotFoundException - no Graph found by the given Id

NullArgumentException - graphId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsNodeLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsNodeLookup() and supportsVisibleFederation() are true

getNodeQuerySession

NodeQuerySession getNodeQuerySession()
                                     throws OperationFailedException

Gets the OsidSession associated with the node query service.

Returns:

a NodeQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsNodeQuery() is false

Compliance:

optional - This method must be implemented if supportsNodeQuery() is true.

getNodeQuerySessionForGraph

NodeQuerySession getNodeQuerySessionForGraph(Id graphId)
                                             throws NotFoundException,
                                                    OperationFailedException

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

Parameters:

graphId - the Id of the graph

Returns:

a NodeQuerySession

Throws:

NotFoundException - no Graph found by the given Id

NullArgumentException - graphId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsNodeQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsNodeQuery() and supportsVisibleFederation() are true

getNodeSearchSession

NodeSearchSession getNodeSearchSession()
                                       throws OperationFailedException

Gets the OsidSession associated with the node search service.

Returns:

a NodeSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsNodeSearch() is false

Compliance:

optional - This method must be implemented if supportsNodeSearch() is true.

getNodeSearchSessionForGraph

NodeSearchSession getNodeSearchSessionForGraph(Id graphId)
                                               throws NotFoundException,
                                                      OperationFailedException

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

Parameters:

graphId - the Id of the Graph

Returns:

a NodeSearchSession

Throws:

NotFoundException - no graph found by the given Id

NullArgumentException - graphId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsNodeSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsNodeSearch() and supportsVisibleFederation() are true

getNodeAdminSession

NodeAdminSession getNodeAdminSession()
                                     throws OperationFailedException

Gets the OsidSession associated with the node administration service.

Returns:

a NodeAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsNodeAdmin() is false

Compliance:

optional - This method must be implemented if supportsNodeAdmin() is true.

getNodeAdminSessionForGraph

NodeAdminSession getNodeAdminSessionForGraph(Id graphId)
                                             throws NotFoundException,
                                                    OperationFailedException

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

Parameters:

graphId - the Id of the Graph

Returns:

a NodeAdminSession

Throws:

NotFoundException - no graph found by the given Id

NullArgumentException - graphId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsNodeAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsNodeAdmin() and supportsVisibleFederation() are true

getNodeNotificationSession

NodeNotificationSession getNodeNotificationSession(NodeReceiver nodeReceiver)
                                                   throws OperationFailedException

Gets the OsidSession associated with the node notification service.

Parameters:

nodeReceiver - the notification callback

Returns:

a NodeNotificationSession

Throws:

NullArgumentException - nodeReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsNodeNotification() is false

Compliance:

optional - This method must be implemented if supportsNodeNotification() is true.

getNodeNotificationSessionForGraph

NodeNotificationSession getNodeNotificationSessionForGraph(NodeReceiver nodeReceiver,
                                                         Id graphId)
                                                           throws NotFoundException,
                                                                  OperationFailedException

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

Parameters:

nodeReceiver - the notification callback

graphId - the Id of the Graph

Returns:

a NodeNotificationSession

Throws:

NotFoundException - no graph found by the given Id

NullArgumentException - nodeReceiver or graphId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsNodeNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsNodeNotification() and supportsVisibleFederation() are true

getNodeGraphSession

NodeGraphSession getNodeGraphSession()
                                     throws OperationFailedException

Gets the OsidSession to lookup node/graph mappings.

Returns:

a NodeGraphSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsNodeGraph() is false

Compliance:

optional - This method must be implemented if supportsNodeGraph() is true.

getNodeGraphAssignmentSession

NodeGraphAssignmentSession getNodeGraphAssignmentSession()
                                                         throws OperationFailedException

Gets the OsidSession associated with assigning nodes to graphs.

Returns:

a NodeGraphAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsNodeGraphAssignment() is false

Compliance:

optional - This method must be implemented if supportsNodeGraphAssignment() is true.

getNodeSmartGraphSession

NodeSmartGraphSession getNodeSmartGraphSession(Id graphId)
                                               throws NotFoundException,
                                                      OperationFailedException

Gets the OsidSession to manage dynamic graphs of retlationships.

Parameters:

graphId - the Id of the Graph

Returns:

a NodeSmartGraphSession

Throws:

NotFoundException - no graph found by the given Id

NullArgumentException - graphId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsNodeSmartGraph() is false

Compliance:

optional - This method must be implemented if supportsNodeSmartGraph() is true.

getEdgeLookupSession

EdgeLookupSession getEdgeLookupSession()
                                       throws OperationFailedException

Gets the OsidSession associated with the edge lookup service.

Returns:

an EdgeLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsEdgeLookup() is false

Compliance:

optional - This method must be implemented if supportsEdgeLookup() is true.

getEdgeLookupSessionForGraph

EdgeLookupSession getEdgeLookupSessionForGraph(Id graphId)
                                               throws NotFoundException,
                                                      OperationFailedException

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

Parameters:

graphId - the Id of the Graph

Returns:

an EdgeLookupSession

Throws:

NotFoundException - no Graph found by the given Id

NullArgumentException - graphId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEdgeLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsEdgeLookup() and supportsVisibleFederation() are true

getEdgeQuerySession

EdgeQuerySession getEdgeQuerySession()
                                     throws OperationFailedException

Gets the OsidSession associated with the edge query service.

Returns:

an EdgeQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsEdgeQuery() is false

Compliance:

optional - This method must be implemented if supportsEdgeQuery() is true.

getEdgeQuerySessionForGraph

EdgeQuerySession getEdgeQuerySessionForGraph(Id graphId)
                                             throws NotFoundException,
                                                    OperationFailedException

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

Parameters:

graphId - the Id of the graph

Returns:

an EdgeQuerySession

Throws:

NotFoundException - no Graph found by the given Id

NullArgumentException - graphId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEdgeQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsEdgeQuery() and supportsVisibleFederation() are true

getEdgeSearchSession

EdgeSearchSession getEdgeSearchSession()
                                       throws OperationFailedException

Gets the OsidSession associated with the edge search service.

Returns:

an EdgeSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsEdgeSearch() is false

Compliance:

optional - This method must be implemented if supportsEdgeSearch() is true.

getEdgeSearchSessionForGraph

EdgeSearchSession getEdgeSearchSessionForGraph(Id graphId)
                                               throws NotFoundException,
                                                      OperationFailedException

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

Parameters:

graphId - the Id of the Graph

Returns:

an EdgeSearchSession

Throws:

NotFoundException - no graph found by the given Id

NullArgumentException - graphId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEdgeSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsEdgeSearch() and supportsVisibleFederation() are true

getEdgeAdminSession

EdgeAdminSession getEdgeAdminSession()
                                     throws OperationFailedException

Gets the OsidSession associated with the edge administration service.

Returns:

an EdgeAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsEdgeAdmin() is false

Compliance:

optional - This method must be implemented if supportsEdgeAdmin() is true.

getEdgeAdminSessionForGraph

EdgeAdminSession getEdgeAdminSessionForGraph(Id graphId)
                                             throws NotFoundException,
                                                    OperationFailedException

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

Parameters:

graphId - the Id of the Graph

Returns:

an EdgeAdminSession

Throws:

NotFoundException - no graph found by the given Id

NullArgumentException - graphId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEdgeAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsEdgeAdmin() and supportsVisibleFederation() are true

getEdgeNotificationSession

EdgeNotificationSession getEdgeNotificationSession(EdgeReceiver edgeReceiver)
                                                   throws OperationFailedException

Gets the OsidSession associated with the edge notification service.

Parameters:

edgeReceiver - the notification callback

Returns:

an EdgeNotificationSession

Throws:

NullArgumentException - edgeReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEdgeNotification() is false

Compliance:

optional - This method must be implemented if supportsEdgeNotification() is true.

getEdgeNotificationSessionForGraph

EdgeNotificationSession getEdgeNotificationSessionForGraph(EdgeReceiver edgeReceiver,
                                                         Id graphId)
                                                           throws NotFoundException,
                                                                  OperationFailedException

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

Parameters:

edgeReceiver - the notification callback

graphId - the Id of the Graph

Returns:

an EdgeNotificationSession

Throws:

NotFoundException - no graph found by the given Id

NullArgumentException - edgeReceiver or graphId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEdgeNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsEdgeNotification() and supportsVisibleFederation() are true

getEdgeGraphSession

EdgeGraphSession getEdgeGraphSession()
                                     throws OperationFailedException

Gets the OsidSession to lookup edge/graph mappings.

Returns:

an EdgeGraphSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsEdgeGraph() is false

Compliance:

optional - This method must be implemented if supportsEdgeGraph() is true.

getEdgeGraphAssignmentSession

EdgeGraphAssignmentSession getEdgeGraphAssignmentSession()
                                                         throws OperationFailedException

Gets the OsidSession associated with assigning edges to graphs.

Returns:

an EdgeGraphAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsEdgeGraphAssignment() is false

Compliance:

optional - This method must be implemented if supportsEdgeGraphAssignment() is true.

getEdgeSmartGraphSession

EdgeSmartGraphSession getEdgeSmartGraphSession(Id graphId)
                                               throws NotFoundException,
                                                      OperationFailedException

Gets the OsidSession to manage dynamic graphs of retlationships.

Parameters:

graphId - the Id of the Graph

Returns:

an EdgeSmartGraphSession

Throws:

NotFoundException - no graph found by the given Id

NullArgumentException - graphId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEdgeSmartGraph() is false

Compliance:

optional - This method must be implemented if supportsEdgeSmartGraph() is true.

getGraphLookupSession

GraphLookupSession getGraphLookupSession()
                                         throws OperationFailedException

Gets the OsidSession associated with the graph lookup service.

Returns:

a GraphLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsGraphLookup() is false

Compliance:

optional - This method must be implemented if supportsGraphLookup() is true.

getGraphQuerySession

GraphQuerySession getGraphQuerySession()
                                       throws OperationFailedException

Gets the OsidSession associated with the graph query service.

Returns:

a GraphQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsGraphQuery() is false

Compliance:

optional - This method must be implemented if supportsGraphQuery() is true.

getGraphSearchSession

GraphSearchSession getGraphSearchSession()
                                         throws OperationFailedException

Gets the OsidSession associated with the graph search service.

Returns:

a GraphSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsGraphSearch() is false

Compliance:

optional - This method must be implemented if supportsGraphSearch() is true.

getGraphAdminSession

GraphAdminSession getGraphAdminSession()
                                       throws OperationFailedException

Gets the OsidSession associated with the graph administrative service.

Returns:

a GraphAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsGraphAdmin() is false

Compliance:

optional - This method must be implemented if supportsGraphAdmin() is true.

getGraphNotificationSession

GraphNotificationSession getGraphNotificationSession(GraphReceiver graphReceiver)
                                                     throws OperationFailedException

Gets the OsidSession associated with the graph notification service.

Parameters:

graphReceiver - the notification callback

Returns:

a GraphNotificationSession

Throws:

NullArgumentException - graphReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGraphNotification() is false

Compliance:

optional - This method must be implemented if supportsGraphNotification() is true.

getGraphHierarchySession

GraphHierarchySession getGraphHierarchySession()
                                               throws OperationFailedException

Gets the OsidSession associated with the graph hierarchy service.

Returns:

a GraphHierarchySession for graphs

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsGraphHierarchy() is false

Compliance:

optional - This method must be implemented if supportsGraphHierarchy() is true.

getGraphHierarchyDesignSession

GraphHierarchyDesignSession getGraphHierarchyDesignSession()
                                                           throws OperationFailedException

Gets the OsidSession associated with the graph hierarchy design service.

Returns:

a HierarchyDesignSession for graphs

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsGraphHierarchyDesign() is false

Compliance:

optional - This method must be implemented if supportsGraphHierarchyDesign() is true.

getTopologyBatchManager

TopologyBatchManager getTopologyBatchManager()
                                             throws OperationFailedException

Gets a TopologyBatchManager.

Returns:

a TopologyBatchManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsTopologyBatch() is false

Compliance:

optional - This method must be implemented if supportsTopologyBatch() is true.

getTopologyPathManager

TopologyPathManager getTopologyPathManager()
                                           throws OperationFailedException

Gets a TopologyPathManager.

Returns:

a TopologyPathManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsTopologyPath() is false

Compliance:

optional - This method must be implemented if supportsTopologyPath() is true.

getTopologyRulesManager

TopologyRulesManager getTopologyRulesManager()
                                             throws OperationFailedException

Gets a TopologyRulesManager.

Returns:

a TopologyRulesManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsTopologyRules() is false

Compliance:

optional - This method must be implemented if supportsTopologyRules() is true.