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
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 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. |
changeBranch, initialize, rollbackService
close
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
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
TopologyTraversalSession getTopologyTraversalSession() throws OperationFailedException
OsidSession
associated with the topology
traversal service. TopologyTraversalSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsTopologyTraversal()
is false
optional
- This method must be implemented if
supportsTopologyTraversal()
is true.
TopologyTraversalSession getTopologyTraversalForGraph(Id graphId) throws NotFoundException, OperationFailedException
OsidSession
associated with the topology
traversal service for the given graph.graphId
- the Id
of the graph TopologyTraversalSession
NotFoundException
- no Graph
found by
the given Id
NullArgumentException
- graphId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsTopologyTraversal()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsTopologyTraversal()
and
supportsVisibleFederation()
are true
TopologyRoutingSession getTopologyRoutingSession() throws OperationFailedException
OsidSession
associated with the topology
routing service. TopologyRoutingSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsTopologyRouting()
is false
optional
- This method must be implemented if
supportsTopologyRouting()
is true.
TopologyRoutingSession getTopologyRoutingForGraph(Id graphId) throws NotFoundException, OperationFailedException
OsidSession
associated with the topology
routing service for the given graph.graphId
- the Id
of the graph TopologyRoutingSession
NotFoundException
- no Graph
found by
the given Id
NullArgumentException
- graphId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsTopologyRouting()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsTopologyRouting()
and
supportsVisibleFederation()
are true
NodeLookupSession getNodeLookupSession() throws OperationFailedException
OsidSession
associated with the node lookup
service. NodeLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsNodeLookup()
is false
optional
- This method must be implemented if
supportsNodeLookup()
is true.
NodeLookupSession getNodeLookupSessionForGraph(Id graphId) throws NotFoundException, OperationFailedException
OsidSession
associated with the node lookup
service for the given graph.graphId
- the Id
of the graph NodeLookupSession
NotFoundException
- no Graph
found by
the given Id
NullArgumentException
- graphId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsNodeLookup()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsNodeLookup()
and
supportsVisibleFederation()
are true
NodeQuerySession getNodeQuerySession() throws OperationFailedException
OsidSession
associated with the node query
service. NodeQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsNodeQuery()
is false
optional
- This method must be implemented if
supportsNodeQuery()
is true.
NodeQuerySession getNodeQuerySessionForGraph(Id graphId) throws NotFoundException, OperationFailedException
OsidSession
associated with the node query
service for the given graph.graphId
- the Id
of the graph NodeQuerySession
NotFoundException
- no Graph
found by
the given Id
NullArgumentException
- graphId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsNodeQuery()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsNodeQuery()
and
supportsVisibleFederation()
are true
NodeSearchSession getNodeSearchSession() throws OperationFailedException
OsidSession
associated with the node search
service. NodeSearchSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsNodeSearch()
is false
optional
- This method must be implemented if
supportsNodeSearch()
is true.
NodeSearchSession getNodeSearchSessionForGraph(Id graphId) throws NotFoundException, OperationFailedException
OsidSession
associated with the node search
service for the given graph.graphId
- the Id
of the Graph
NodeSearchSession
NotFoundException
- no graph found by the given
Id
NullArgumentException
- graphId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsNodeSearch()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsNodeSearch()
and
supportsVisibleFederation()
are true
NodeAdminSession getNodeAdminSession() throws OperationFailedException
OsidSession
associated with the node
administration service. NodeAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsNodeAdmin()
is false
optional
- This method must be implemented if
supportsNodeAdmin()
is true.
NodeAdminSession getNodeAdminSessionForGraph(Id graphId) throws NotFoundException, OperationFailedException
OsidSession
associated with the node
administration service for the given graph.graphId
- the Id
of the Graph
NodeAdminSession
NotFoundException
- no graph found by the given
Id
NullArgumentException
- graphId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsNodeAdmin()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsNodeAdmin()
and
supportsVisibleFederation()
are true
NodeNotificationSession getNodeNotificationSession(NodeReceiver nodeReceiver) throws OperationFailedException
OsidSession
associated with the node
notification service.nodeReceiver
- the notification callback NodeNotificationSession
NullArgumentException
- nodeReceiver
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsNodeNotification()
is false
optional
- This method must be implemented if
supportsNodeNotification()
is true.
NodeNotificationSession getNodeNotificationSessionForGraph(NodeReceiver nodeReceiver, Id graphId) throws NotFoundException, OperationFailedException
OsidSession
associated with the node
notification service for the given graph.nodeReceiver
- the notification callbackgraphId
- the Id
of the Graph
NodeNotificationSession
NotFoundException
- no graph found by the given
Id
NullArgumentException
- nodeReceiver
or
graphId
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsNodeNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsNodeNotification()
and
supportsVisibleFederation()
are true
NodeGraphSession getNodeGraphSession() throws OperationFailedException
OsidSession
to lookup node/graph mappings. NodeGraphSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsNodeGraph()
is false
optional
- This method must be implemented if
supportsNodeGraph()
is true.
NodeGraphAssignmentSession getNodeGraphAssignmentSession() throws OperationFailedException
OsidSession
associated with assigning nodes to
graphs. NodeGraphAssignmentSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsNodeGraphAssignment()
is false
optional
- This method must be implemented if
supportsNodeGraphAssignment()
is true.
NodeSmartGraphSession getNodeSmartGraphSession(Id graphId) throws NotFoundException, OperationFailedException
OsidSession
to manage dynamic graphs of
retlationships.graphId
- the Id
of the Graph
NodeSmartGraphSession
NotFoundException
- no graph found by the given
Id
NullArgumentException
- graphId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsNodeSmartGraph()
is false
optional
- This method must be implemented if
supportsNodeSmartGraph()
is true.
EdgeLookupSession getEdgeLookupSession() throws OperationFailedException
OsidSession
associated with the edge lookup
service. EdgeLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsEdgeLookup()
is false
optional
- This method must be implemented if
supportsEdgeLookup()
is true.
EdgeLookupSession getEdgeLookupSessionForGraph(Id graphId) throws NotFoundException, OperationFailedException
OsidSession
associated with the edge lookup
service for the given graph.graphId
- the Id
of the Graph
EdgeLookupSession
NotFoundException
- no Graph
found by
the given Id
NullArgumentException
- graphId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsEdgeLookup()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsEdgeLookup()
and
supportsVisibleFederation()
are true
EdgeQuerySession getEdgeQuerySession() throws OperationFailedException
OsidSession
associated with the edge query
service. EdgeQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsEdgeQuery()
is false
optional
- This method must be implemented if
supportsEdgeQuery()
is true.
EdgeQuerySession getEdgeQuerySessionForGraph(Id graphId) throws NotFoundException, OperationFailedException
OsidSession
associated with the edge query
service for the given graph.graphId
- the Id
of the graph EdgeQuerySession
NotFoundException
- no Graph
found by
the given Id
NullArgumentException
- graphId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsEdgeQuery()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsEdgeQuery()
and
supportsVisibleFederation()
are true
EdgeSearchSession getEdgeSearchSession() throws OperationFailedException
OsidSession
associated with the edge search
service. EdgeSearchSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsEdgeSearch()
is false
optional
- This method must be implemented if
supportsEdgeSearch()
is true.
EdgeSearchSession getEdgeSearchSessionForGraph(Id graphId) throws NotFoundException, OperationFailedException
OsidSession
associated with the edge search
service for the given graph.graphId
- the Id
of the Graph
EdgeSearchSession
NotFoundException
- no graph found by the given
Id
NullArgumentException
- graphId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsEdgeSearch()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsEdgeSearch()
and
supportsVisibleFederation()
are true
EdgeAdminSession getEdgeAdminSession() throws OperationFailedException
OsidSession
associated with the edge
administration service. EdgeAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsEdgeAdmin()
is false
optional
- This method must be implemented if
supportsEdgeAdmin()
is true.
EdgeAdminSession getEdgeAdminSessionForGraph(Id graphId) throws NotFoundException, OperationFailedException
OsidSession
associated with the edge
administration service for the given graph.graphId
- the Id
of the Graph
EdgeAdminSession
NotFoundException
- no graph found by the given
Id
NullArgumentException
- graphId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsEdgeAdmin()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsEdgeAdmin()
and
supportsVisibleFederation()
are true
EdgeNotificationSession getEdgeNotificationSession(EdgeReceiver edgeReceiver) throws OperationFailedException
OsidSession
associated with the edge
notification service.edgeReceiver
- the notification callback EdgeNotificationSession
NullArgumentException
- edgeReceiver
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsEdgeNotification()
is false
optional
- This method must be implemented if
supportsEdgeNotification()
is true.
EdgeNotificationSession getEdgeNotificationSessionForGraph(EdgeReceiver edgeReceiver, Id graphId) throws NotFoundException, OperationFailedException
OsidSession
associated with the edge
notification service for the given graph.edgeReceiver
- the notification callbackgraphId
- the Id
of the Graph
EdgeNotificationSession
NotFoundException
- no graph found by the given
Id
NullArgumentException
- edgeReceiver
or
graphId
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsEdgeNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsEdgeNotification()
and
supportsVisibleFederation()
are true
EdgeGraphSession getEdgeGraphSession() throws OperationFailedException
OsidSession
to lookup edge/graph mappings. EdgeGraphSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsEdgeGraph()
is false
optional
- This method must be implemented if
supportsEdgeGraph()
is true.
EdgeGraphAssignmentSession getEdgeGraphAssignmentSession() throws OperationFailedException
OsidSession
associated with assigning edges to
graphs. EdgeGraphAssignmentSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsEdgeGraphAssignment()
is false
optional
- This method must be implemented if
supportsEdgeGraphAssignment()
is true.
EdgeSmartGraphSession getEdgeSmartGraphSession(Id graphId) throws NotFoundException, OperationFailedException
OsidSession
to manage dynamic graphs of
retlationships.graphId
- the Id
of the Graph
EdgeSmartGraphSession
NotFoundException
- no graph found by the given
Id
NullArgumentException
- graphId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsEdgeSmartGraph()
is false
optional
- This method must be implemented if
supportsEdgeSmartGraph()
is true.
GraphLookupSession getGraphLookupSession() throws OperationFailedException
OsidSession
associated with the graph lookup
service. GraphLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsGraphLookup()
is false
optional
- This method must be implemented if
supportsGraphLookup()
is true.
GraphQuerySession getGraphQuerySession() throws OperationFailedException
OsidSession
associated with the graph query
service. GraphQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsGraphQuery()
is false
optional
- This method must be implemented if
supportsGraphQuery()
is true.
GraphSearchSession getGraphSearchSession() throws OperationFailedException
OsidSession
associated with the graph search
service. GraphSearchSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsGraphSearch()
is false
optional
- This method must be implemented if
supportsGraphSearch()
is true.
GraphAdminSession getGraphAdminSession() throws OperationFailedException
OsidSession
associated with the graph
administrative service. GraphAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsGraphAdmin()
is false
optional
- This method must be implemented if
supportsGraphAdmin()
is true.
GraphNotificationSession getGraphNotificationSession(GraphReceiver graphReceiver) throws OperationFailedException
OsidSession
associated with the graph
notification service.graphReceiver
- the notification callback GraphNotificationSession
NullArgumentException
- graphReceiver
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsGraphNotification()
is false
optional
- This method must be implemented if
supportsGraphNotification()
is true.
GraphHierarchySession getGraphHierarchySession() throws OperationFailedException
OsidSession
associated with the graph
hierarchy service. GraphHierarchySession
for graphsOperationFailedException
- unable to complete requestUnimplementedException
-
supportsGraphHierarchy()
is false
optional
- This method must be implemented if
supportsGraphHierarchy()
is true.
GraphHierarchyDesignSession getGraphHierarchyDesignSession() throws OperationFailedException
OsidSession
associated with the graph
hierarchy design service. HierarchyDesignSession
for graphsOperationFailedException
- unable to complete requestUnimplementedException
-
supportsGraphHierarchyDesign()
is false
optional
- This method must be implemented if
supportsGraphHierarchyDesign()
is true.
TopologyBatchManager getTopologyBatchManager() throws OperationFailedException
TopologyBatchManager.
TopologyBatchManager
OperationFailedException
- unable to complete requestUnimplementedException
- supportsTopologyBatch()
is false
optional
- This method must be implemented if
supportsTopologyBatch()
is true.
TopologyPathManager getTopologyPathManager() throws OperationFailedException
TopologyPathManager.
TopologyPathManager
OperationFailedException
- unable to complete requestUnimplementedException
- supportsTopologyPath()
is false
optional
- This method must be implemented if
supportsTopologyPath()
is true.
TopologyRulesManager getTopologyRulesManager() throws OperationFailedException
TopologyRulesManager.
TopologyRulesManager
OperationFailedException
- unable to complete requestUnimplementedException
- supportsTopologyRules()
is false
optional
- This method must be implemented if
supportsTopologyRules()
is true.