OSID - osid.control.SystemAdminSession Service Interface Definition

Interface	osid.control.SystemAdminSession
Implements	`osid.OsidSession`
Implemented By	`osid.control.batch.SystemBatchAdminSession`
Used By	`osid.control.ControlManager`
Used By	`osid.control.ControlProxyManager`
Description	This session creates, updates, and deletes `Systems`. 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 `System`, a `SystemForm` is requested using `getSystemFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `SystemForm` 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 `SystemForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `SystemForm` corresponds to an attempted transaction. For updates, `SystemForms` are requested to the `System` `Id` that is to be updated using `getSystemFormForUpdate()`. Similarly, the `SystemForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `SystemForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Systems`. This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
Method	canCreateSystems
Description	Tests if this user can create `Systems`. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `System`. will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may not wish to offer create operations to unauthorized users.
Return	`boolean`		`false` if `System` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateSystemWithRecordTypes
Description	Tests if this user can create a single `System` using the desired record types. While `ControlManager.getSystemRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `System`. Providing an empty array tests if a `System` can be created with no records.
Parameters	`osid.type.Type[]`	`systemRecordTypes`	array of system record types
Return	`boolean`		`true` if `System` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`systemRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getSystemFormForCreate
Description	Gets the system form for creating new systems. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`systemRecordTypes`	array of system record types
Return	`osid.control.SystemForm`		the system form
Errors	NULL_ARGUMENT		`systemRecordTypes` 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	createSystem
Description	Creates a new `System`.
Parameters	`osid.control.SystemForm`	`systemForm`	the form for this `System`
Return	`osid.control.System`		the new `System`
Errors	ILLEGAL_STATE		`systemForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`systemForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`systemForm` did not originate from `getSystemFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateSystems
Description	Tests if this user can update `Systems`. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `System` will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may not wish to offer update operations to unauthorized users.
Return	`boolean`		`false` if `System` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getSystemFormForUpdate
Description	Gets the system form for updating an existing system. A new system form should be requested for each update transaction.
Parameters	`osid.id.Id`	`systemId`	the `Id` of the `System`
Return	`osid.control.SystemForm`		the system form
Errors	NOT_FOUND		`systemId` is not found
	NULL_ARGUMENT		`systemId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateSystem
Description	Updates an existing system
Parameters	`osid.control.SystemForm`	`systemForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`systemForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`systemForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`systemForm` did not originate from `getSystemFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteSystems
Description	Tests if this user can delete `Systems`. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `System` will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may not wish to offer delete operations to unauthorized users.
Return	`boolean`		`false` if `System` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteSystem
Description	Deletes a `System`.
Parameters	`osid.id.Id`	`systemId`	the `Id` of the `System` to remove
Errors	NOT_FOUND		`systemId` not found
	NULL_ARGUMENT		`systemId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageSystemAliases
Description	Tests if this user can manage `Id` aliases for `Systems`. 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 `System` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasSystem
Description	Adds an `Id` to a `System` for the purpose of creating compatibility. The primary `Id` of the `System` is determined by the provider. The new `Id` performs as an alias to the primary `Id`.
Parameters	`osid.id.Id`	`systemId`	the `Id` of a `System`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`systemId` not found
	NULL_ARGUMENT		`systemId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.