OSID Logo
OSID Specifications
topology path package
Version 3.0.0
Release Candidate Preview
Interfaceosid.topology.path.TopologyPathProxyManager
Implementsosid.OsidProxyManager
osid.topology.path.TopologyPathProfile
Description

The topology manager provides access to topology path 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:

  • PathLookupSession: a session to retrieve paths
  • PathQuerySession: a session to query for paths
  • PathSearchSession: a session to search for paths
  • PathAdminSession: a session to create and delete paths
  • PathNotificationSession: a session to receive notifications pertaining to path changes
  • PathMapSession: a session to looking locations of paths to maps
  • PathMapAssignmentSession: a session to manage path to graph mappings
  • PathMapAssignmentSession: a session to manage dynamic graphs of paths
MethodgetPathLookupSession
Description

Gets the OsidSession associated with the path lookup service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.topology.path.PathLookupSessiona PathLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPathLookup() is false
ComplianceoptionalThis method must be implemented if supportsPathLookup() is true.
MethodgetPathLookupSessionForGraph
Description

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

Parametersosid.id.IdgraphIdthe Id of the Graph
osid.proxy.Proxyproxya proxy
Returnosid.topology.path.PathLookupSessiona PathLookupSession
ErrorsNOT_FOUNDno graph found by the given Id
NULL_ARGUMENT graphId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPathLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsPathLookup() and supportsVisibleFederation() are true
MethodgetPathQuerySession
Description

Gets the OsidSession associated with the path query service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.topology.path.PathQuerySessiona PathQuerySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPathQuery() is false
ComplianceoptionalThis method must be implemented if supportsPathQuery() is true.
MethodgetPathQuerySessionForGraph
Description

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

Parametersosid.id.IdgraphIdthe Id of the Graph
osid.proxy.Proxyproxya proxy
Returnosid.topology.path.PathQuerySessiona PathQuerySession
ErrorsNOT_FOUNDno graph found by the given Id
NULL_ARGUMENT graphId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPathQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsPathQuery() and supportsVisibleFederation() are true
MethodgetPathSearchSession
Description

Gets the OsidSession associated with the path search service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.topology.path.PathSearchSessiona PathSearchSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPathSearch() is false
ComplianceoptionalThis method must be implemented if supportsPathSearch() is true.
MethodgetPathSearchSessionForGraph
Description

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

Parametersosid.id.IdgraphIdthe Id of the Graph
osid.proxy.Proxyproxya proxy
Returnosid.topology.path.PathSearchSessiona PathSearchSession
ErrorsNOT_FOUNDno graph found by the given Id
NULL_ARGUMENT graphId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPathSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsPathSearch() and supportsVisibleFederation() are true
MethodgetPathAdminSession
Description

Gets the OsidSession associated with the path administration service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.topology.path.PathAdminSessiona PathAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPathAdmin() is false
ComplianceoptionalThis method must be implemented if supportsPathAdmin() is true.
MethodgetPathAdminSessionForGraph
Description

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

Parametersosid.id.IdgraphIdthe Id of the Graph
osid.proxy.Proxyproxya proxy
Returnosid.topology.path.PathAdminSessiona PathAdminSession
ErrorsNOT_FOUNDno graph found by the given Id
NULL_ARGUMENT graphId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPathAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsPathAdmin() and supportsVisibleFederation() are true
MethodgetPathNotificationSession
Description

Gets the OsidSession associated with the path notification service.

Parametersosid.topology.path.PathReceiverpathReceiverthe notification callback
osid.proxy.Proxyproxya proxy
Returnosid.topology.path.PathNotificationSessiona PathNotificationSession
ErrorsNULL_ARGUMENT pathReceiver or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPathNotification() is false
ComplianceoptionalThis method must be implemented if supportsPathNotification() is true.
MethodgetPathNotificationSessionForGraph
Description

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

Parametersosid.topology.path.PathReceiverpathReceiverthe notification callback
osid.id.IdgraphIdthe Id of the Graph
osid.proxy.Proxyproxya proxy
Returnosid.topology.path.PathNotificationSessiona PathNotificationSession
ErrorsNOT_FOUNDno graph found by the given Id
NULL_ARGUMENT pathReceiver, graphId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPathNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsPathNotification() and supportsVisibleFederation() are true
MethodgetPathGraphSession
Description

Gets the OsidSession to lookup path/graph mappings.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.topology.path.PathGraphSessiona PathGraphSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPathGraph() is false
ComplianceoptionalThis method must be implemented if supportsPathGraph() is true.
MethodgetPathGraphAssignmentSession
Description

Gets the OsidSession associated with assigning paths to maps.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.topology.path.PathGraphAssignmentSessiona PathGraphAssignmentSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPathGraphAssignment() is false
ComplianceoptionalThis method must be implemented if supportsPathGraphAssignment() is true.
MethodgetPathSmartGraphSession
Description

Gets the OsidSession to manage path smart graphs.

Parametersosid.id.IdgraphIdthe Id of the Graph
osid.proxy.Proxyproxya proxy
Returnosid.topology.path.PathSmartGraphSessiona PathSmartMGraphSession
ErrorsNOT_FOUNDno graph found by the given Id
NULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPathSmartGraph() is false
ComplianceoptionalThis method must be implemented if supportsPathSmartGraph() is true.