OSID - osid.topology.path.TopologyPathManager Service Interface Definition

Interface	osid.topology.path.TopologyPathManager
Implements	`osid.OsidManager`
Implements	`osid.topology.path.TopologyPathProfile`
Used By	`osid.topology.TopologyManager`
Description	The topology manager provides access to topology path sessions and provides interoperability tests for various aspects of this service. 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
Method	getPathLookupSession
Description	Gets the `OsidSession` associated with the path lookup service.
Return	`osid.topology.path.PathLookupSession`		a `PathLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsPathLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPathLookup()` is `true`.
Method	getPathLookupSessionForGraph
Description	Gets the `OsidSession` associated with the path lookup service for the given graph.
Parameters	`osid.id.Id`	`graphId`	the `Id` of the `Graph`
Return	`osid.topology.path.PathLookupSession`		a `PathLookupSession`
Errors	NOT_FOUND		no `Graph` found by the given `Id`
	NULL_ARGUMENT		`graphId` 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 `OsidSession` associated with the path query service.
Return	`osid.topology.path.PathQuerySession`		a `PathQuerySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsPathQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPathQuery()` is `true`.
Method	getPathQuerySessionForGraph
Description	Gets the `OsidSession` associated with the path query service for the given graph.
Parameters	`osid.id.Id`	`graphId`	the `Id` of the `Graph`
Return	`osid.topology.path.PathQuerySession`		a `PathQuerySession`
Errors	NOT_FOUND		no graph found by the given `Id`
	NULL_ARGUMENT		`graphId` 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 `OsidSession` associated with the path search service.
Return	`osid.topology.path.PathSearchSession`		a `PathSearchSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsPathSearch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPathSearch()` is `true`.
Method	getPathSearchSessionForGraph
Description	Gets the `OsidSession` associated with the path search service for the given graph.
Parameters	`osid.id.Id`	`graphId`	the `Id` of the `Graph`
Return	`osid.topology.path.PathSearchSession`		a `PathSearchSession`
Errors	NOT_FOUND		no graph found by the given `Id`
	NULL_ARGUMENT		`graphId` 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 `OsidSession` associated with the path administration service.
Return	`osid.topology.path.PathAdminSession`		a `PathAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsPathAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPathAdmin()` is `true`.
Method	getPathAdminSessionForGraph
Description	Gets the `OsidSession` associated with the path administration service for the given graph.
Parameters	`osid.id.Id`	`graphId`	the `Id` of the `graph`
Return	`osid.topology.path.PathAdminSession`		a `PathAdminSession`
Errors	NOT_FOUND		no graph found by the given `Id`
	NULL_ARGUMENT		`graphId` 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 `OsidSession` associated with the path notification service.
Parameters	`osid.topology.path.PathReceiver`	`pathReceiver`	the notification callback
Return	`osid.topology.path.PathNotificationSession`		a `PathNotificationSession`
Errors	NULL_ARGUMENT		`pathReceiver` 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 `OsidSession` associated with the path notification service for the given graph.
Parameters	`osid.topology.path.PathReceiver`	`pathReceiver`	the notification callback
Parameters	`osid.id.Id`	`graphId`	the `Id` of the `Graph`
Return	`osid.topology.path.PathNotificationSession`		a `PathNotificationSession`
Errors	NOT_FOUND		no graph found by the given `Id`
	NULL_ARGUMENT		`pathReceiver` or `graphId` 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 `OsidSession` to lookup path/graph locations.
Return	`osid.topology.path.PathGraphSession`		a `PathGraphSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsPathGraph()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPathGraph()` is `true`.
Method	getPathGraphAssignmentSession
Description	Gets the `OsidSession` associated with assigning paths to graphs.
Return	`osid.topology.path.PathGraphAssignmentSession`		a `PathGraphAssignmentSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsPathGraphAssignment()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPathGraphAssignment()` is `true`.
Method	getPathSmartGraphSession
Description	Gets the `OsidSession` to manage path smart graphs.
Parameters	`osid.id.Id`	`graphId`	the `Id` of the `Graph`
Return	`osid.topology.path.PathSmartGraphSession`		a `PathSmartGraphSession`
Errors	NOT_FOUND		no graph found by the given `Id`
	NULL_ARGUMENT		`pathReceiver` or `graphId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsPathSmartGraph()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPathSmartGraph()` is `true`.