OSID - osid.control.DeviceAdminSession Service Interface Definition

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