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

Interface	osid.mapping.path.SignalMapAssignmentSession
Implements	`osid.OsidSession`
Used By	`osid.mapping.path.MappingPathManager`
Used By	`osid.mapping.path.MappingPathProxyManager`
Description	This session provides methods to re-assign `Signals` to `Map` objects A `Signal` may appear in multiple `Map` objects and removing the last reference to a `Signal` 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 `Signal` to another `Map` is not a copy operation (eg: does not change its `Id`).
Method	canAssignSignals
Description	Tests if this user can alter signal/map mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known signal 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 signal is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canAssignSignalsToMap
Description	Tests if this user can alter signal/map mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known signal 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 signal 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	getAssignableMapIdsForSignal
Description	Gets a list of maps including and under the given map node in which a specific signal can be assigned.
Parameters	`osid.id.Id`	`mapId`	the `Id` of the `Map`
Parameters	`osid.id.Id`	`signalId`	the `Id` of the `Signal`
Return	`osid.id.IdList`		list of assignable map `Ids`
Errors	NULL_ARGUMENT		`mapId` or `signalId` is `null`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	assignSignalToMap
Description	Adds an existing `Signal` to a `Map`.
Parameters	`osid.id.Id`	`signalId`	the `Id` of the `Signal`
Parameters	`osid.id.Id`	`mapId`	the `Id` of the `Map`
Errors	ALREADY_EXISTS		`signalId` is already assigned to `mapId`
	NOT_FOUND		`signalId` or `mapId` not found
	NULL_ARGUMENT		`signalId` or `mapId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	unassignSignalFromMap
Description	Removes a `Signal` from a `Map`.
Parameters	`osid.id.Id`	`signalId`	the `Id` of the `Signal`
Parameters	`osid.id.Id`	`mapId`	the `Id` of the `Map`
Errors	NOT_FOUND		`signalId` or `mapId` not found or `signalId` not assigned to `mapId`
	NULL_ARGUMENT		`signalId` or `mapId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.