OSID - osid.workflow.StepAdminSession Service Interface Definition

Interface	osid.workflow.StepAdminSession
Implements	`osid.OsidSession`
Implemented By	`osid.workflow.batch.StepBatchAdminSession`
Used By	`osid.workflow.WorkflowManager`
Used By	`osid.workflow.WorkflowProxyManager`
Description	This session creates, updates, and deletes `Steps`. 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 `Step`, a `StepForm` is requested using `getStepFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `StepForm` 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 `StepForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `StepForm` corresponds to an attempted transaction. For updates, `StepForms` are requested to the `Step` `Id` that is to be updated using `getStepFormForUpdate()`. Similarly, the `StepForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `StepForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Steps`. To unmap a `Step` from the current `Office`, the `StepOfficeAssignmentSession` should be used. These delete operations attempt to remove the `Step` 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	canCreateSteps
Description	Tests if this user can create `Steps`. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `Step` 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 `Step` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateStepWithRecordTypes
Description	Tests if this user can create a single `Step` using the desired record types. While `WorkflowManager.getStepRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Step`. Providing an empty array tests if a `Step` can be created with no records.
Parameters	`osid.type.Type[]`	`stepRecordTypes`	array of step record types
Return	`boolean`		`true` if `Step` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`stepRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getStepFormForCreate
Description	Gets the step form for creating new steps. A new form should be requested for each create transaction.
Parameters	`osid.id.Id`	`processId`	a process `Id`
Parameters	`osid.type.Type[]`	`stepRecordTypes`	array of step record types
Return	`osid.workflow.StepForm`		the step form
Errors	NOT_FOUND		`processId` is not found
	NULL_ARGUMENT		`processId` or `stepRecordTypes` 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	createStep
Description	Creates a new `Step`.
Parameters	`osid.workflow.StepForm`	`stepForm`	the form for this `Step`
Return	`osid.workflow.Step`		the new `Step`
Errors	ILLEGAL_STATE		`stepForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`stepForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`stepForm` did not originate from `getStepFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateSteps
Description	Tests if this user can update `Steps`. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `Step` 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 `Step` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getStepFormForUpdate
Description	Gets the step form for updating an existing step. A new step form should be requested for each update transaction.
Parameters	`osid.id.Id`	`stepId`	the `Id` of the `Step`
Return	`osid.workflow.StepForm`		the step form
Errors	NOT_FOUND		`stepId` is not found
	NULL_ARGUMENT		`stepId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateStep
Description	Updates an existing step.
Parameters	`osid.workflow.StepForm`	`stepForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`stepForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`stepForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`stepForm` did not originate from `getStepFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteSteps
Description	Tests if this user can delete `Steps`. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `Step` 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 `Step` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteStep
Description	Deletes a `Step`.
Parameters	`osid.id.Id`	`stepId`	the `Id` of the `Step` to remove
Errors	NOT_FOUND		`stepId` not found
	NULL_ARGUMENT		`stepId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageStepAliases
Description	Tests if this user can manage `Id` aliases for `Steps`. 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 `Step` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasStep
Description	Adds an `Id` to a `Step` for the purpose of creating compatibility. The primary `Id` of the `Step` is determined by the provider. The new `Id` performs as an alias to the primary `Id`. If the alias is a pointer to another step, it is reassigned to the given step `Id`.
Parameters	`osid.id.Id`	`stepId`	the `Id` of a `Step`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`stepId` not found
	NULL_ARGUMENT		`stepId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.