OSID - osid.process.StateAdminSession Service Interface Definition

Interface	osid.process.StateAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `States.` 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 `State,` a `StateForm` is requested using `getStateFormForCreate()` specifying the desired relationship peers and record `Types` or none if no record `Types` are needed. The returned `StateForm` 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 `StateForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `StateForm` corresponds to an attempted transaction. For updates, `StateForms` are requested to the `State` `Id` that is to be updated using `getStateFormForUpdate().` Similarly, the `StateForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `StateForm` can only be used once for a successful update and cannot be reused. The delete operations delete `States.` To unmap a `State` from the current `Process,` the `StateProcessAssignmentSession` should be used. These delete operations attempt to remove the `State` itself thus removing it from all known `Process` catalogs. This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
Method	getProcessId
Description	Gets the `Process` `Id` associated with this session.
Return	`osid.id.Id`		the `Process Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getProcess
Description	Gets the `Process` associated with this session.
Return	`osid.process.Process`		the `Process` associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canCreateStates
Description	Tests if this user can create `States.` A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `State` 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 `State` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateStateWithRecordTypes
Description	Tests if this user can create a single `State` using the desired record types. While `ProcessManager.getStateRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `State.` Providing an empty array tests if a `State` can be created with no records.
Parameters	`osid.type.Type[]`	`stateRecordTypes`	array of state record types
Return	`boolean`		`true` if `State` creation using the specified `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`stateRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getStateFormForCreate
Description	Gets the state form for creating new states. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`stateRecordTypes`	array of state record types
Return	`osid.process.StateForm`		the state form
Errors	NULL_ARGUMENT		`stateRecordTypes` 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	createState
Description	Creates a new `State.`
Parameters	`osid.process.StateForm`	`stateForm`	the form for this `State`
Return	`osid.process.State`		the new `State`
Errors	ILLEGAL_STATE		`stateForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`stateForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`stateForm` did not originate from `getStateFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateStates
Description	Tests if this user can update `States.` A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `State` 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 `State` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getStateFormForUpdate
Description	Gets the state form for updating an existing state. A new state form should be requested for each update transaction.
Parameters	`osid.id.Id`	`stateId`	the `Id` of the `State`
Return	`osid.process.StateForm`		the state form
Errors	NOT_FOUND		`stateId` is not found
	NULL_ARGUMENT		`stateId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateState
Description	Updates an existing state.
Parameters	`osid.process.StateForm`	`stateForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`stateForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`stateId` or `stateForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`stateForm` did not originate from `getStateFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteStates
Description	Tests if this user can delete `States.` A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `State` 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 `State` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteState
Description	Deletes a `State.`
Parameters	`osid.id.Id`	`stateId`	the `Id` of the `State` to remove
Errors	NOT_FOUND		`stateId` not found
	NULL_ARGUMENT		`stateId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageStateAliases
Description	Tests if this user can manage `Id` aliases for `States.` 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 `State` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasState
Description	Adds an `Id` to a `State` for the purpose of creating compatibility. The primary `Id` of the `State` is determined by the provider. The new `Id` performs as an alias to the primary `Id.` If the alias is a pointer to another state, it is reassigned to the given state `Id.`
Parameters	`osid.id.Id`	`stateId`	the `Id` of a `State`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`stateId` not found
	NULL_ARGUMENT		`aliasId` or `stateId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.