OSID - osid.control.ControllerSystemAssignmentSession Service Interface Definition

Interface	osid.control.ControllerSystemAssignmentSession
Implements	`osid.OsidSession`
Used By	`osid.control.ControlManager`
Used By	`osid.control.ControlProxyManager`
Description	This session provides methods to re-assign `Controller` to `System` mappings. A `Controller` may appear in multiple `Systems` and removing the last reference to a `Controller` is the equivalent of deleting it. Each `System` may have its own authorizations governing who is allowed to operate on it. Adding a reference of a `Controller` to another `System` is not a copy operation (eg: does not change its `Id`).
Method	canAssignControllers
Description	Tests if this user can alter controller/system 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.
Return	`boolean`		`false` if mapping is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canAssignControllersToSystem
Description	Tests if this user can alter controller/system 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`	`systemId`	the `Id` of the `System`
Return	`boolean`		`false` if mapping is not authorized, `true` otherwise
Errors	NULL_ARGUMENT		`systemId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getAssignableSystemIds
Description	Gets a list of systems including and under the given system node in which any controller can be assigned.
Parameters	`osid.id.Id`	`systemId`	the `Id` of the `System`
Return	`osid.id.IdList`		list of assignable system `Ids`
Errors	NULL_ARGUMENT		`systemId` is `null`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getAssignableSystemIdsForController
Description	Gets a list of systems including and under the given system node in which a specific controller can be assigned.
Parameters	`osid.id.Id`	`systemId`	the `Id` of the `System`
Parameters	`osid.id.Id`	`controllerId`	the `Id` of the `Controller`
Return	`osid.id.IdList`		list of assignable system `Ids`
Errors	NULL_ARGUMENT		`systemId` or `controllerId` is `null`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	assignControllerToSystem
Description	Adds an existing `Controller` to a `System`.
Parameters	`osid.id.Id`	`controllerId`	the `Id` of the `Controller`
Parameters	`osid.id.Id`	`systemId`	the `Id` of the `System`
Errors	ALREADY_EXISTS		`controllerId` is already assigned to `systemId`
	NOT_FOUND		`controllerId` or `systemId` not found
	NULL_ARGUMENT		`controllerId` or `systemId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	unassignControllerFromSystem
Description	Removes a `Controller` from a `System`.
Parameters	`osid.id.Id`	`controllerId`	the `Id` of the `Controller`
Parameters	`osid.id.Id`	`systemId`	the `Id` of the `System`
Errors	NOT_FOUND		`controllerId` or `systemId` not found or `controllerId` not assigned to `systemId`
	NULL_ARGUMENT		`controllerId` or `systemId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	reassignControllerToSystem
Description	Moves a `Controller` from one `System` to another. Mappings to other `Systems` are unaffected.
Parameters	`osid.id.Id`	`controllerId`	the `Id` of the `Controller`
	`osid.id.Id`	`fromSystemId`	the `Id` of the current `System`
	`osid.id.Id`	`toSystemId`	the `Id` of the destination `System`
Errors	ALREADY_EXISTS		`controllerId` already assigned to `toSystemId`
	NOT_FOUND		`controllerId, fromSystemId`, or `toSystemId` not found or `controllerId` not mapped to `fromSystemId`
	NULL_ARGUMENT		`controllerId, fromSystemId`, or `toSystemId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.