OSID - osid.control.ControllerAdminSession Service Interface Definition

Interface	osid.control.ControllerAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `Controllers.` The data for create and update is provided by the consumer via the form object. `OsidForms` are requested for each create or update and may not be reused. Create and update operations differ in their usage. To create a `Controller,` a `ControllerForm` is requested using `getControllerFormForCreate()` specifying the record `Types` or none if no record `Types` are needed. The returned `ControllerForm` will indicate that it is to be used with a create operation and can be used to examine metdata or validate data prior to creation. Once the `ControllerForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `ControllerForm` corresponds to an attempted transaction. For updates, `ControllerForms` are requested to the `Controller` `Id` that is to be updated using `getControllerFormForUpdate().` Similarly, the `ControllerForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `ControllerForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Controllers.` To unmap a `Controller` from the current `System,` the `ControllerSystemAssignmentSession` should be used. These delete operations attempt to remove the `Controller` itself thus removing it from all known `System` catalogs. This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
Method	getSystemId
Description	Gets the `System` `Id` associated with this session.
Return	`osid.id.Id`		the `System Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getSystem
Description	Gets the `System` associated with this session.
Return	`osid.control.System`		the system
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canCreateController
Description	Tests if this user can create controllers. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `Controller` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer create operations to an unauthorized user.
Return	`boolean`		`false` if `Controller` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateControllerWithRecordTypes
Description	Tests if this user can create a single `Controller` using the desired record types. While `ControlManager.getControllerRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Controller.` Providing an empty array tests if a `Controller` can be created with no records.
Parameters	`osid.type.Type[]`	`controllerRecordTypes`	array of controller record types
Return	`boolean`		`true` if `Controller` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`controllerRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getControllerFormForCreate
Description	Gets the controller form for creating new controllers. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`controllerRecordTypes`	array of controller record types
Return	`osid.control.ControllerForm`		the controller form
Errors	NULL_ARGUMENT		`controllerRecordTypes` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		unable to get form for requested record types
Compliance	`mandatory`		This method must be implemented.
Method	createController
Description	Creates a new `Controller.`
Parameters	`osid.control.ControllerForm`	`controllerForm`	the form for this `Controller`
Return	`osid.control.Controller`		the new `Controller`
Errors	ILLEGAL_STATE		`controllerForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`controllerForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`controllerForm` did not originate from `getControllerFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateControllers
Description	Tests if this user can update controllers. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `Controller` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer update operations to an unauthorized user.
Return	`boolean`		`false` if `Controller` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getControllerFormForUpdate
Description	Gets the controller form for updating an existing controller. A new controller form should be requested for each update transaction.
Parameters	`osid.id.Id`	`controllerId`	the `Id` of the `Controller`
Return	`osid.control.ControllerForm`		the controller form
Errors	NOT_FOUND		`controllerId` is not found
	NULL_ARGUMENT		`controllerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateController
Description	Updates an existing controller.
Parameters	`osid.control.ControllerForm`	`controllerForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`controllerForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`controllerForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`controllerForm` did not originate from `getControllerFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteControllers
Description	Tests if this user can delete controllers. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `Controller` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer delete operations to an unauthorized user.
Return	`boolean`		`false` if `Controller` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteController
Description	Deletes a `Controller.`
Parameters	`osid.id.Id`	`controllerId`	the `Id` of the `Controller` to remove
Errors	NOT_FOUND		`controllerId` not found
	NULL_ARGUMENT		`controllerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageControllerAliases
Description	Tests if this user can manage `Id` aliases for controllers. A return of true does not guarantee successful authorization. A return of false indicates that it is known changing an alias will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer alias operations to an unauthorized user.
Return	`boolean`		`false` if `Controller` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasController
Description	Adds an `Id` to a `Controller` for the purpose of creating compatibility. The primary `Id` of the `Controller` is determined by the provider. The new `Id` performs as an alias to the primary `Id` . If the alias is a pointer to another controller, it is reassigned to the given controller `Id.`
Parameters	`osid.id.Id`	`controllerId`	the `Id` of a `Controller`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`controllerId` not found
	NULL_ARGUMENT		`controllerId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.