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

Interface	osid.topology.path.PathGraphAssignmentSession
Implements	`osid.OsidSession`
Used By	`osid.topology.path.TopologyPathManager`
Used By	`osid.topology.path.TopologyPathProxyManager`
Description	This session provides methods to re-assign `Paths` to `Graph` objects. A `Path` may appear in multiple `Graph` objects and removing the last reference to a `Path` is the equivalent of deleting it. Each `Graph` may have its own authorizations governing who is allowed to operate on it. Adding a reference of a `Path` to another `Graph` is not a copy operation (eg: does not change its `Id`).
Method	canAssignPaths
Description	Tests if this user can alter path/graph mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known location methods in this session will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer assignment operations to unauthorized users.
Return	`boolean`		`false` if mapping is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canAssignPathsToGraph
Description	Tests if this user can alter path/graph mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping methods in this session will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer assignment operations to unauthorized users.
Parameters	`osid.id.Id`	`graphId`	the `Id` of the `Graph`
Return	`boolean`		`false` if mapping is not authorized, `true` otherwise
Errors	NULL_ARGUMENT		`graphId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getAssignableGraphIds
Description	Gets a list of graphs including and under the given graph node in which any path can be assigned.
Parameters	`osid.id.Id`	`graphId`	the `Id` of the `Graph`
Return	`osid.id.IdList`		list of assignable graph `Ids`
Errors	NULL_ARGUMENT		`graphId` is `null`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getAssignableGraphIdsForPath
Description	Gets a list of graphs including and under the given graph node in which a specific path can be assigned.
Parameters	`osid.id.Id`	`graphId`	the `Id` of the `Graph`
Parameters	`osid.id.Id`	`pathId`	the `Id` of the `Path`
Return	`osid.id.IdList`		list of assignable graph `Ids`
Errors	NULL_ARGUMENT		`graphId` or `pathId` is `null`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	assignPathToGraph
Description	Adds an existing `Path` to a `Graph`.
Parameters	`osid.id.Id`	`pathId`	the `Id` of the `Path`
Parameters	`osid.id.Id`	`graphId`	the `Id` of the `Graph`
Errors	ALREADY_EXISTS		`pathId` is already assigned to `graphId`
	NOT_FOUND		`pathId` or `graphId` not found
	NULL_ARGUMENT		`pathId` or `graphId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	unassignPathFromGraph
Description	Removes a `Path` from a `Graph`.
Parameters	`osid.id.Id`	`pathId`	the `Id` of the `Path`
Parameters	`osid.id.Id`	`graphId`	the `Id` of the `Graph`
Errors	NOT_FOUND		`pathId` or `graphId` not found or `pathId` not assigned to `graphId`
	NULL_ARGUMENT		`pathId` or `graphId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	reassignPathToGraph
Description	Moves a `Path` from one `Graph` to another. Mappings to other `Graphs` are unaffected.
Parameters	`osid.id.Id`	`pathId`	the `Id` of the `Credit`
	`osid.id.Id`	`fromGraphId`	the `Id` of the current `Graph`
	`osid.id.Id`	`toGraphId`	the `Id` of the destination `Graph`
Errors	ALREADY_EXISTS		`pathId` already assigned to `toGraphId`
	NOT_FOUND		`pathId, fromGraphId`, or `toGraphId` not found or `pathId` not mapped to `fromGraphId`
	NULL_ARGUMENT		`pathId, fromGraphId`, or `toGraphId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.