OSID - osid.control.InputAdminSession Service Interface Definition

Interface	osid.control.InputAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `Inputs.` 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 `Input,` a `InputForm` is requested using `getInputFormForCreate()` specifying the desired device, controller, and record `Types` or none if no record `Types` are needed. The returned `InputForm` 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 `InputForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `InputForm` corresponds to an attempted transaction. For updates, `InputForms` are requested to the `Input` `Id` that is to be updated using `getInputFormForUpdate().` Similarly, the `InputForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `InputForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Inputs.` To unmap a `Input` from the current `System,` the `InputSystemAssignmentSession` should be used. These delete operations attempt to remove the `Input` 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	canCreateInputs
Description	Tests if this user can create `Inputs.` A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `Input` 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 `Input` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateInputWithRecordTypes
Description	Tests if this user can create a single `Input` using the desired record types. While `ControlManager.getInputRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Input.` Providing an empty array tests if a `Input` can be created with no records.
Parameters	`osid.type.Type[]`	`inputRecordTypes`	array of input record types
Return	`boolean`		`true` if `Input` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`inputRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getInputFormForCreate
Description	Gets the input form for creating new inputs. A new form should be requested for each create transaction.
Parameters	`osid.id.Id`	`deviceId`	a device `Id`
	`osid.id.Id`	`controllerId`	a controller `Id`
	`osid.type.Type[]`	`inputRecordTypes`	array of input record types
Return	`osid.control.InputForm`		the input form
Errors	NOT_FOUND		`deviceId` or `controllerId` is not found
	NULL_ARGUMENT		`deviceId, controllerId,` or `inputRecordTypes` 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	createInput
Description	Creates a new `Input.`
Parameters	`osid.control.InputForm`	`inputForm`	the form for this `Input`
Return	`osid.control.Input`		the new `Input`
Errors	ILLEGAL_STATE		`inputForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`inputForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`inputForm` did not originate from `getInputFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateInputs
Description	Tests if this user can update `Inputs.` A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `Input` 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 `Input` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getInputFormForUpdate
Description	Gets the input form for updating an existing input. A new input form should be requested for each update transaction.
Parameters	`osid.id.Id`	`inputId`	the `Id` of the `Input`
Return	`osid.control.InputForm`		the input form
Errors	NOT_FOUND		`inputId` is not found
	NULL_ARGUMENT		`inputId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateInput
Description	Updates an existing input.
Parameters	`osid.control.InputForm`	`inputForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`inputForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`inputForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`inputForm` did not originate from `getInputFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteInputs
Description	Tests if this user can delete `Inputs.` A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `Input` 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 `Input` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteInput
Description	Deletes a `Input.`
Parameters	`osid.id.Id`	`inputId`	the `Id` of the `Input` to remove
Errors	NOT_FOUND		`inputId` not found
	NULL_ARGUMENT		`inputId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageInputAliases
Description	Tests if this user can manage `Id` aliases for `Inputs.` 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 `Input` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasInput
Description	Adds an `Id` to a `Input` for the purpose of creating compatibility. The primary `Id` of the `Input` is determined by the provider. The new `Id` performs as an alias to the primary `Id.` If the alias is a pointer to another input, it is reassigned to the given input `Id.`
Parameters	`osid.id.Id`	`inputId`	the `Id` of a `Input`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`inputId` not found
	NULL_ARGUMENT		`inputId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.