OSID - osid.workflow.ProcessAdminSession Service Interface Definition

Interface	osid.workflow.ProcessAdminSession
Implements	`osid.OsidSession`
Implemented By	`osid.workflow.batch.ProcessBatchAdminSession`
Used By	`osid.workflow.WorkflowManager`
Used By	`osid.workflow.WorkflowProxyManager`
Description	This session creates, updates, and deletes `Processes`. The data for create and update is provided by the consumer via the form. `OsidForms` are requested for each create or update and may not be reused. Create and update operations differ in their usage. To create a `Process`, a `ProcessForm` is requested using `getProcessFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `ProcessForm` 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 `ProcessForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `ProcessForm` corresponds to an attempted transaction. For updates, `ProcessForms` are requested to the `Process` `Id` that is to be updated using `getProcessFormForUpdate()`. Similarly, the `ProcessForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `ProcessForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Processes`. To unmap a `Process` from the current `Office`, the `ProcessOfficeAssignmentSession` should be used. These delete operations attempt to remove the `Process` itself thus removing it from all known `Office` catalogs. This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
Method	getOfficeId
Description	Gets the `Office` `Id` associated with this session.
Return	`osid.id.Id`		the `Office Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getOffice
Description	Gets the `Office` associated with this session.
Return	`osid.workflow.Office`		the office
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canCreateProcesses
Description	Tests if this user can create `Process`. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `Process` 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 `Process` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateProcessWithRecordTypes
Description	Tests if this user can create a single `Process` using the desired record types. While `WorkflowManager.getProcessRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Process`. Providing an empty array tests if a `Process` can be created with no records.
Parameters	`osid.type.Type[]`	`processRecordTypes`	array of process record types
Return	`boolean`		`true` if `Process` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`processRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getProcessFormForCreate
Description	Gets the process form for creating new processes. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`processRecordTypes`	array of process record types
Return	`osid.workflow.ProcessForm`		the process form
Errors	NULL_ARGUMENT		`processRecordTypes` 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	createProcess
Description	Creates a new `Process`.
Parameters	`osid.workflow.ProcessForm`	`processForm`	the form for this `Process`
Return	`osid.workflow.Process`		the new `Process`
Errors	ILLEGAL_STATE		`processForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`processForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`processForm` did not originate from `getProcessFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateProcesses
Description	Tests if this user can update `Processes`. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `Process` 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 `Process` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getProcessFormForUpdate
Description	Gets the process form for updating an existing process. A new process form should be requested for each update transaction.
Parameters	`osid.id.Id`	`processId`	the `Id` of the `Process`
Return	`osid.workflow.ProcessForm`		the process form
Errors	NOT_FOUND		`processId` is not found
	NULL_ARGUMENT		`processId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateProcess
Description	Updates an existing process.
Parameters	`osid.workflow.ProcessForm`	`processForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`processForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`processForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`processForm` did not originate from `getProcessFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteProcesses
Description	Tests if this user can delete `Processes`. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `Process` 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 `Process` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteProcess
Description	Deletes a `Process`.
Parameters	`osid.id.Id`	`processId`	the `Id` of the `Process` to remove
Errors	NOT_FOUND		`processId` not found
	NULL_ARGUMENT		`processId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageProcessAliases
Description	Tests if this user can manage `Id` aliases for `Process`. 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 `Process` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasProcess
Description	Adds an `Id` to a `Process` for the purpose of creating compatibility. The primary `Id` of the `Process` is determined by the provider. The new `Id` performs as an alias to the primary `Id`. If the alias is a pointer to another process, it is reassigned to the given process `Id`.
Parameters	`osid.id.Id`	`processId`	the `Id` of a `Process`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`processId` not found
	NULL_ARGUMENT		`processId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canAssignCompetencies
Description	Tests if this user can assign competencies to process. A return of true does not guarantee successful authorization. A return of false indicates that it is known assigning a competency will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer competency operations to an unauthorized user.
Return	`boolean`		`false` if competency assignment is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	addCompetency
Description	Adds a competency to a process.
Parameters	`osid.id.Id`	`processId`	the processId `Id`
Parameters	`osid.id.Id`	`competencyId`	the competency `Id`
Errors	ALREADY_EXISTS		competency already part of work
	NOT_FOUND		`competencyId` or `processId` is not found
	NULL_ARGUMENT		`competencyId` or `processId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	removeCompetency
Description	Removes a competency from a process.
Parameters	`osid.id.Id`	`processId`	the process `Id`
Parameters	`osid.id.Id`	`competencyId`	the competency `Id`
Errors	NOT_FOUND		competency is not part of process
	NULL_ARGUMENT		`processId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	removeCompetencies
Description	Removes all competency from a process.
Parameters	`osid.id.Id`	`processId`	the process `Id`
Errors	NOT_FOUND		`processId` is not found
	NULL_ARGUMENT		`processId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.