OSID - osid.mapping.path.PathMapAssignmentSession Service Interface Definition

Interface	osid.mapping.path.PathMapAssignmentSession
Implements	`osid.OsidSession`
Used By	`osid.mapping.path.MappingPathManager`
Used By	`osid.mapping.path.MappingPathProxyManager`
Description	This session provides methods to re-assign `Paths` to `Map` objects. A `Path` may appear in multiple `Map` objects and removing the last reference to a `Path` is the equivalent of deleting it. Each `Map` may have its own authorizations governing who is allowed to operate on it. Adding a reference of a `Path` to another `Map` is not a copy operation (eg: does not change its `Id`).
Method	canAssignPaths
Description	Tests if this user can alter path/map 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	canAssignPathsToMap
Description	Tests if this user can alter path/map 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.
Parameters	`osid.id.Id`	`mapId`	the `Id` of the `Map`
Return	`boolean`		`false` if mapping is not authorized, `true` otherwise
Errors	NULL_ARGUMENT		`mapId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getAssignableMapIds
Description	Gets a list of maps including and under the given map node in which any path can be assigned.
Parameters	`osid.id.Id`	`mapId`	the `Id` of the `Map`
Return	`osid.id.IdList`		list of assignable map `Ids`
Errors	NULL_ARGUMENT		`mapId` is `null`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getAssignableMapIdsForPath
Description	Gets a list of maps including and under the given map node in which a specific path can be assigned.
Parameters	`osid.id.Id`	`mapId`	the `Id` of the `Map`
Parameters	`osid.id.Id`	`pathId`	the `Id` of the `Path`
Return	`osid.id.IdList`		list of assignable map `Ids`
Errors	NULL_ARGUMENT		`mapId` or `pathId` is `null`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	assignPathToMap
Description	Adds an existing `Path` to a `Map`.
Parameters	`osid.id.Id`	`pathId`	the `Id` of the `Path`
Parameters	`osid.id.Id`	`mapId`	the `Id` of the `Map`
Errors	ALREADY_EXISTS		`pathId` is already assigned to `mapId`
	NOT_FOUND		`pathId` or `mapId` not found
	NULL_ARGUMENT		`pathId` or `mapId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	unassignPathFromMap
Description	Removes a `Path` from a `Map`.
Parameters	`osid.id.Id`	`pathId`	the `Id` of the `Path`
Parameters	`osid.id.Id`	`mapId`	the `Id` of the `Map`
Errors	NOT_FOUND		`pathId` or `mapId` not found or `pathId` not assigned to `mapId`
	NULL_ARGUMENT		`pathId` or `mapId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.