Interface TopologyManager

All Superinterfaces:

AutoCloseable, Closeable, OsidManager, 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

Modifier and Type	Method	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 Closeable

close

Methods inherited from interface OsidManager

close

Modifier and Type	Method	Description
void	close()	Close this manager.

Methods inherited from interface OsidManager

changeBranch, initialize, rollbackService

Modifier and Type	Method	Description
void	changeBranch(Id branchId)	Changes the service branch.
void	initialize(OsidRuntimeManager runtime)	Initializes this manager.
JournalEntry	rollbackService(Date rollbackTime)	Rolls back this service to a point in time.

Methods inherited from interface OsidProfile

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

Modifier and Type	Method	Description
Branch	getBranch()	Gets this service branch.
Id	getBranchId()	Gets the Branch Id representing this service branch.
DisplayText	getDescription()	Gets a description of this service implementation.
DisplayText	getDisplayName()	Gets a display name for this service implementation.
Id	getId()	Gets an identifier for this service implementation.
LocaleList	getLocales()	Gets the locales supported in this service.
TypeList	getProxyRecordTypes()	Gets the proxy record Types supported in this service.
DateTime	getReleaseDate()	Gets the date this service implementation was released.
Version	getVersion()	Gets the version of this service implementation.
boolean	supportsJournalBranching()	Test for support of a journal branching service.
boolean	supportsJournalRollback()	Test for support of a journaling rollback service.
boolean	supportsOSIDVersion(Version version)	Test for support of an OSID specification version.
boolean	supportsProxyRecordType(Type proxyRecordType)	Test for support of a proxy type.

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Modifier and Type	Method	Description
AssetList	getBranding()	Gets a branding, such as an image or logo, expressed using the Asset interface.
IdList	getBrandingIds()	Gets the branding asset Ids .
DisplayText	getLicense()	Gets the terms of usage.
Resource	getProvider()	Gets the Resource representing the provider.
Id	getProviderId()	Gets the Id of the provider.

Methods inherited from interface 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

Modifier and Type	Method	Description
TypeList	getEdgeRecordTypes()	Gets the supported Edge record types.
TypeList	getEdgeSearchRecordTypes()	Gets the supported Edge search record types.
TypeList	getGraphRecordTypes()	Gets the supported Graph record types.
TypeList	getGraphSearchRecordTypes()	Gets the supported Graph search record types.
TypeList	getNodeRecordTypes()	Gets the supported Node record types.
TypeList	getNodeSearchRecordTypes()	Gets the supported Node search types.
boolean	supportsEdgeAdmin()	Tests if edge administrative service is supported.
boolean	supportsEdgeGraph()	Tests if an edge graph mapping lookup service is supported.
boolean	supportsEdgeGraphAssignment()	Tests if an edge graph mapping service is supported.
boolean	supportsEdgeLookup()	Tests if looking up edges is supported.
boolean	supportsEdgeNotification()	Tests if an edge notification service is supported.
boolean	supportsEdgeRecordType(Type edgeRecordType)	Tests if the given Edge record type is supported.
boolean	supportsEdgeSearch()	Tests if searching edges is supported.
boolean	supportsEdgeSearchRecordType(Type edgeSearchRecordType)	Tests if the given Edge search record type is supported.
boolean	supportsEdgeSmartGraph()	Tests if an edgesmart graph cataloging service is supported.
boolean	supportsGraphAdmin()	Tests if graph administrative service is supported.
boolean	supportsGraphHierarchy()	Tests for the availability of a graph hierarchy traversal service.
boolean	supportsGraphHierarchyDesign()	Tests for the availability of a graph hierarchy design service.
boolean	supportsGraphLookup()	Tests if looking up graphs is supported.
boolean	supportsGraphNotification()	Tests if a graph notification service is supported.
boolean	supportsGraphQuery()	Tests if querying graphs is supported.
boolean	supportsGraphRecordType(Type graphRecordType)	Tests if the given Graph record type is supported.
boolean	supportsGraphSearch()	Tests if searching graphs is supported.
boolean	supportsGraphSearchRecordType(Type graphSearchRecordType)	Tests if the given Graph search record type is supported.
boolean	supportsNodeAdmin()	Tests if node administrative service is supported.
boolean	supportsNodeGraph()	Tests if a node graph mapping lookup service is supported.
boolean	supportsNodeGraphAssignment()	Tests if a node graph mapping service is supported.
boolean	supportsNodeLookup()	Tests if looking up nodes is supported.
boolean	supportsNodeNotification()	Tests if a node notification service is supported.
boolean	supportsNodeQuery()	Tests if querying nodes is supported.
boolean	supportsNodeRecordType(Type nodeRecordType)	Tests if the given Node record type is supported.
boolean	supportsNodeSearch()	Tests if searching nodes is supported.
boolean	supportsNodeSearchRecordType(Type nodeSearchRecordType)	Tests if the given Node search type is supported.
boolean	supportsNodeSmartGraph()	Tests if a node smart graph cataloging service is supported.
boolean	supportsTopologyBatch()	Tests for the availability of a topology pbatchath service.
boolean	supportsTopologyPath()	Tests for the availability of a topology path service.
boolean	supportsTopologyRouting()	Tests if topology routing is supported.
boolean	supportsTopologyRules()	Tests for the availability of a topology rules service.
boolean	supportsTopologyTraversal()	Tests if traversing topologies is supported.
boolean	supportsVisibleFederation()	Tests if any graph federation is exposed.

Method Details

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 {@code supportsTopologyTraversal()} is {@code 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 {@code supportsTopologyTraversal()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsTopologyRouting()} is {@code 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 {@code supportsTopologyRouting()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsNodeLookup()} is {@code 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 {@code supportsNodeLookup()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsNodeQuery()} is {@code 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 {@code supportsNodeQuery()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsNodeSearch()} is {@code 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 {@code supportsNodeSearch()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsNodeAdmin()} is {@code 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 {@code supportsNodeAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsNodeNotification()} is {@code 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 {@code supportsNodeNotification()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsNodeGraph()} is {@code 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 {@code supportsNodeGraphAssignment()} is {@code 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 {@code supportsNodeSmartGraph()} is {@code 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 {@code supportsEdgeLookup()} is {@code 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 {@code supportsEdgeLookup()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsEdgeQuery()} is {@code 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 {@code supportsEdgeQuery()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsEdgeSearch()} is {@code 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 {@code supportsEdgeSearch()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsEdgeAdmin()} is {@code 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 {@code supportsEdgeAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsEdgeNotification()} is {@code 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 {@code supportsEdgeNotification()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsEdgeGraph()} is {@code 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 {@code supportsEdgeGraphAssignment()} is {@code 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 {@code supportsEdgeSmartGraph()} is {@code 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 {@code supportsGraphLookup()} is {@code 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 {@code supportsGraphQuery()} is {@code 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 {@code supportsGraphSearch()} is {@code 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 {@code supportsGraphAdmin()} is {@code 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 {@code supportsGraphNotification()} is {@code 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 {@code supportsGraphHierarchy()} is {@code 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 {@code supportsGraphHierarchyDesign()} is {@code 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 {@code supportsTopologyBatch()} is {@code 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 {@code supportsTopologyPath()} is {@code 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 {@code supportsTopologyRules()} is {@code true} .