Interface | osid.topology.path.TopologyPathProxyManager | ||
---|---|---|---|
Implements | osid.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
| ||
Method | getPathLookupSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.topology.path.PathLookupSession | a PathLookupSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPathLookup() is false | ||
Compliance | optional | This method must be implemented if supportsPathLookup() is
true. | |
Method | getPathLookupSessionForGraph | ||
Description |
Gets the | ||
Parameters | osid.id.Id | graphId | the Id of the Graph |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.topology.path.PathLookupSession | a PathLookupSession | |
Errors | NOT_FOUND | no graph found by the given Id | |
NULL_ARGUMENT | graphId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPathLookup() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsPathLookup() and
supportsVisibleFederation() are true | |
Method | getPathQuerySession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.topology.path.PathQuerySession | a PathQuerySession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPathQuery() is false | ||
Compliance | optional | This method must be implemented if supportsPathQuery() is
true. | |
Method | getPathQuerySessionForGraph | ||
Description |
Gets the | ||
Parameters | osid.id.Id | graphId | the Id of the Graph |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.topology.path.PathQuerySession | a PathQuerySession | |
Errors | NOT_FOUND | no graph found by the given Id | |
NULL_ARGUMENT | graphId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPathQuery() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsPathQuery() and
supportsVisibleFederation() are true | |
Method | getPathSearchSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.topology.path.PathSearchSession | a PathSearchSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPathSearch() is false | ||
Compliance | optional | This method must be implemented if supportsPathSearch() is
true. | |
Method | getPathSearchSessionForGraph | ||
Description |
Gets the | ||
Parameters | osid.id.Id | graphId | the Id of the Graph |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.topology.path.PathSearchSession | a PathSearchSession | |
Errors | NOT_FOUND | no graph found by the given Id | |
NULL_ARGUMENT | graphId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPathSearch() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsPathSearch() and
supportsVisibleFederation() are true | |
Method | getPathAdminSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.topology.path.PathAdminSession | a PathAdminSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPathAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsPathAdmin() is
true. | |
Method | getPathAdminSessionForGraph | ||
Description |
Gets the | ||
Parameters | osid.id.Id | graphId | the Id of the Graph |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.topology.path.PathAdminSession | a PathAdminSession | |
Errors | NOT_FOUND | no graph found by the given Id | |
NULL_ARGUMENT | graphId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPathAdmin() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsPathAdmin() and
supportsVisibleFederation() are true | |
Method | getPathNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.topology.path.PathReceiver | pathReceiver | the notification callback |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.topology.path.PathNotificationSession | a PathNotificationSession | |
Errors | NULL_ARGUMENT | pathReceiver or proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPathNotification() is false | ||
Compliance | optional | This method must be implemented if supportsPathNotification()
is true. | |
Method | getPathNotificationSessionForGraph | ||
Description |
Gets the | ||
Parameters | osid.topology.path.PathReceiver | pathReceiver | the notification callback |
osid.id.Id | graphId | the Id of the Graph | |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.topology.path.PathNotificationSession | a PathNotificationSession | |
Errors | NOT_FOUND | no graph found by the given Id | |
NULL_ARGUMENT | pathReceiver, graphId or proxy is null
| ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPathNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsPathNotification()
and supportsVisibleFederation() are true | |
Method | getPathGraphSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.topology.path.PathGraphSession | a PathGraphSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPathGraph() is false | ||
Compliance | optional | This method must be implemented if supportsPathGraph() is
true. | |
Method | getPathGraphAssignmentSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.topology.path.PathGraphAssignmentSession | a PathGraphAssignmentSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPathGraphAssignment() is false | ||
Compliance | optional | This method must be implemented if supportsPathGraphAssignment()
is true. | |
Method | getPathSmartGraphSession | ||
Description |
Gets the | ||
Parameters | osid.id.Id | graphId | the Id of the Graph |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.topology.path.PathSmartGraphSession | a PathSmartMGraphSession | |
Errors | NOT_FOUND | no graph found by the given Id | |
NULL_ARGUMENT | proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPathSmartGraph() is false | ||
Compliance | optional | This method must be implemented if supportsPathSmartGraph()
is true. |