org.osid.topology

Interface TopologyProxyManager

All Superinterfaces:

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

public interface TopologyProxyManager
extends OsidProxyManager, TopologyProfile

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

Method Summary

Methods

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

Methods inherited from interface org.osid.OsidProxyManager

changeBranch, initialize, rollbackService

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

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(Proxy proxy)
                                                     throws OperationFailedException

Gets the OsidSession associated with the topology traversal service.

Parameters:

proxy - a proxy

Returns:

a TopologyTraversalSession

Throws:

NullArgumentException - proxy is null

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,
                                                    Proxy proxy)
                                                      throws NotFoundException,
                                                             OperationFailedException

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

Parameters:

graphId - the Id of the graph

proxy - a proxy

Returns:

a TopologyTraversalSession

Throws:

NotFoundException - no Graph found by the given Id

NullArgumentException - graphId or proxy 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(Proxy proxy)
                                                 throws OperationFailedException

Gets the OsidSession associated with the topology routing service.

Parameters:

proxy - a proxy

Returns:

a TopologyRoutingSession

Throws:

NullArgumentException - proxy is null

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,
                                                Proxy proxy)
                                                  throws NotFoundException,
                                                         OperationFailedException

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

Parameters:

graphId - the Id of the graph

proxy - a proxy

Returns:

a TopologyRoutingSession

Throws:

NotFoundException - no Graph found by the given Id

NullArgumentException - graphId or proxy 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(Proxy proxy)
                                       throws OperationFailedException

Gets the OsidSession associated with the node lookup service.

Parameters:

proxy - a proxy

Returns:

a NodeLookupSession

Throws:

NullArgumentException - proxy is null

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,
                                             Proxy proxy)
                                               throws NotFoundException,
                                                      OperationFailedException

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

Parameters:

graphId - the Id of the graph

proxy - a proxy

Returns:

a NodeLookupSession

Throws:

NotFoundException - no Graph found by the given Id

NullArgumentException - graphId or proxy 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(Proxy proxy)
                                     throws OperationFailedException

Gets the OsidSession associated with the node query service.

Parameters:

proxy - a proxy

Returns:

a NodeQuerySession

Throws:

NullArgumentException - proxy is null

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,
                                           Proxy proxy)
                                             throws NotFoundException,
                                                    OperationFailedException

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

Parameters:

graphId - the Id of the graph

proxy - a proxy

Returns:

a NodeQuerySession

Throws:

NotFoundException - no Graph found by the given Id

NullArgumentException - graphId or proxy 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(Proxy proxy)
                                       throws OperationFailedException

Gets the OsidSession associated with the node search service.

Parameters:

proxy - a proxy

Returns:

a NodeSearchSession

Throws:

NullArgumentException - proxy is null

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,
                                             Proxy proxy)
                                               throws NotFoundException,
                                                      OperationFailedException

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

Parameters:

graphId - the Id of the Graph

proxy - a proxy

Returns:

a NodeSearchSession

Throws:

NotFoundException - no graph found by the given Id

NullArgumentException - graphId or proxy 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(Proxy proxy)
                                     throws OperationFailedException

Gets the OsidSession associated with the node administration service.

Parameters:

proxy - a proxy

Returns:

a NodeAdminSession

Throws:

NullArgumentException - proxy is null

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,
                                           Proxy proxy)
                                             throws NotFoundException,
                                                    OperationFailedException

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

Parameters:

graphId - the Id of the Graph

proxy - a proxy

Returns:

a NodeAdminSession

Throws:

NotFoundException - no graph found by the given Id

NullArgumentException - graphId or proxy 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,
                                                 Proxy proxy)
                                                   throws OperationFailedException

Gets the OsidSession associated with the node notification service.

Parameters:

nodeReceiver - the notification callback

proxy - a proxy

Returns:

a NodeNotificationSession

Throws:

NullArgumentException - nodeReceiver or proxy 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,
                                                         Proxy proxy)
                                                           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

proxy - a proxy

Returns:

a NodeNotificationSession

Throws:

NotFoundException - no graph found by the given Id

NullArgumentException - nodeReceiver, graphId or proxy 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(Proxy proxy)
                                     throws OperationFailedException

Gets the OsidSession to lookup node/graph mappings.

Parameters:

proxy - a proxy

Returns:

a NodeGraphSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsNodeGraph() is false

Compliance:

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

getNodeGraphAssignmentSession

NodeGraphAssignmentSession getNodeGraphAssignmentSession(Proxy proxy)
                                                         throws OperationFailedException

Gets the OsidSession associated with assigning nodes to graphs.

Parameters:

proxy - a proxy

Returns:

a NodeGraphAssignmentSession

Throws:

NullArgumentException - proxy is null

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,
                                             Proxy proxy)
                                               throws NotFoundException,
                                                      OperationFailedException

Gets the OsidSession to manage dynamic graphs of retlationships.

Parameters:

graphId - the Id of the Graph

proxy - a proxy

Returns:

a NodeSmartGraphSession

Throws:

NotFoundException - no graph found by the given Id

NullArgumentException - graphId or proxy 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(Proxy proxy)
                                       throws OperationFailedException

Gets the OsidSession associated with the edge lookup service.

Parameters:

proxy - a proxy

Returns:

an EdgeLookupSession

Throws:

NullArgumentException - proxy is null

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,
                                             Proxy proxy)
                                               throws NotFoundException,
                                                      OperationFailedException

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

Parameters:

graphId - the Id of the Graph

proxy - a proxy

Returns:

an EdgeLookupSession

Throws:

NotFoundException - no Graph found by the given Id

NullArgumentException - graphId or proxy 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(Proxy proxy)
                                     throws OperationFailedException

Gets the OsidSession associated with the edge query service.

Parameters:

proxy - a proxy

Returns:

an EdgeQuerySession

Throws:

NullArgumentException - proxy is null

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,
                                           Proxy proxy)
                                             throws NotFoundException,
                                                    OperationFailedException

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

Parameters:

graphId - the Id of the graph

proxy - a proxy

Returns:

an EdgeQuerySession

Throws:

NotFoundException - no Graph found by the given Id

NullArgumentException - graphId or proxy 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(Proxy proxy)
                                       throws OperationFailedException

Gets the OsidSession associated with the edge search service.

Parameters:

proxy - a proxy

Returns:

an EdgeSearchSession

Throws:

NullArgumentException - proxy is null

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,
                                             Proxy proxy)
                                               throws NotFoundException,
                                                      OperationFailedException

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

Parameters:

graphId - the Id of the Graph

proxy - a proxy

Returns:

an EdgeSearchSession

Throws:

NotFoundException - no graph found by the given Id

NullArgumentException - graphId or proxy 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(Proxy proxy)
                                     throws OperationFailedException

Gets the OsidSession associated with the edge administration service.

Parameters:

proxy - a proxy

Returns:

an EdgeAdminSession

Throws:

NullArgumentException - proxy is null

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,
                                           Proxy proxy)
                                             throws NotFoundException,
                                                    OperationFailedException

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

Parameters:

graphId - the Id of the Graph

proxy - a proxy

Returns:

an EdgeAdminSession

Throws:

NotFoundException - no graph found by the given Id

NullArgumentException - graphId or proxy 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,
                                                 Proxy proxy)
                                                   throws OperationFailedException

Gets the OsidSession associated with the edge notification service.

Parameters:

edgeReceiver - the notification callback

proxy - a proxy

Returns:

an EdgeNotificationSession

Throws:

NullArgumentException - edgeReceiver or proxy 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,
                                                         Proxy proxy)
                                                           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

proxy - a proxy

Returns:

an EdgeNotificationSession

Throws:

NotFoundException - no graph found by the given Id

NullArgumentException - edgeReceiver, graphId or proxy 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(Proxy proxy)
                                     throws OperationFailedException

Gets the OsidSession to lookup edge/graph mappings.

Parameters:

proxy - a proxy

Returns:

an EdgeGraphSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEdgeGraph() is false

Compliance:

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

getEdgeGraphAssignmentSession

EdgeGraphAssignmentSession getEdgeGraphAssignmentSession(Proxy proxy)
                                                         throws OperationFailedException

Gets the OsidSession associated with assigning edges to graphs.

Parameters:

proxy - a proxy

Returns:

an EdgeGraphAssignmentSession

Throws:

NullArgumentException - proxy is null

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,
                                             Proxy proxy)
                                               throws NotFoundException,
                                                      OperationFailedException

Gets the OsidSession to manage dynamic graphs of retlationships.

Parameters:

graphId - the Id of the Graph

proxy - a proxy

Returns:

an EdgeSmartGraphSession

Throws:

NotFoundException - no graph found by the given Id

NullArgumentException - graphId or proxy 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(Proxy proxy)
                                         throws OperationFailedException

Gets the OsidSession associated with the graph lookup service.

Parameters:

proxy - a proxy

Returns:

a GraphLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGraphLookup() is false

Compliance:

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

getGraphQuerySession

GraphQuerySession getGraphQuerySession(Proxy proxy)
                                       throws OperationFailedException

Gets the OsidSession associated with the graph query service.

Parameters:

proxy - a proxy

Returns:

a GraphQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGraphQuery() is false

Compliance:

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

getGraphSearchSession

GraphSearchSession getGraphSearchSession(Proxy proxy)
                                         throws OperationFailedException

Gets the OsidSession associated with the graph search service.

Parameters:

proxy - a proxy

Returns:

a GraphSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGraphSearch() is false

Compliance:

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

getGraphAdminSession

GraphAdminSession getGraphAdminSession(Proxy proxy)
                                       throws OperationFailedException

Gets the OsidSession associated with the graph administrative service.

Parameters:

proxy - a proxy

Returns:

a GraphAdminSession

Throws:

NullArgumentException - proxy is null

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,
                                                   Proxy proxy)
                                                     throws OperationFailedException

Gets the OsidSession associated with the graph notification service.

Parameters:

graphReceiver - the notification callback

proxy - a proxy

Returns:

a GraphNotificationSession

Throws:

NullArgumentException - graphReceiver or proxy 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(Proxy proxy)
                                               throws OperationFailedException

Gets the OsidSession associated with the graph hierarchy service.

Parameters:

proxy - a proxy

Returns:

a GraphHierarchySession for graphs

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGraphHierarchy() is false

Compliance:

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

getGraphHierarchyDesignSession

GraphHierarchyDesignSession getGraphHierarchyDesignSession(Proxy proxy)
                                                           throws OperationFailedException

Gets the OsidSession associated with the graph hierarchy design service.

Parameters:

proxy - a proxy

Returns:

a HierarchyDesignSession for graphs

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGraphHierarchyDesign() is false

Compliance:

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

getTopologyBatchProxyManager

TopologyBatchProxyManager getTopologyBatchProxyManager()
                                                       throws OperationFailedException

Gets a TopologyBatchManager.

Returns:

a TopologyBatchProxyManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsTopologyBatch() is false

Compliance:

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

getTopologyPathProxyManager

TopologyPathProxyManager getTopologyPathProxyManager()
                                                     throws OperationFailedException

Gets a TopologyPathManager.

Returns:

a TopologyPathProxyManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsTopologyPath() is false

Compliance:

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

getTopologyRulesProxyManager

TopologyRulesProxyManager getTopologyRulesProxyManager()
                                                       throws OperationFailedException

Gets a TopologyRulesManager.

Returns:

a TopologyRulesProxyManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsTopologyRules() is false

Compliance:

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