OSID - osid.workflow.rules.StepProcessorAdminSession Service Interface Definition

Interface	osid.workflow.rules.StepProcessorAdminSession
Implements	`osid.OsidSession`
Used By	`osid.workflow.rules.WorkflowRulesManager`
Used By	`osid.workflow.rules.WorkflowRulesProxyManager`
Description	This session creates and removes step processors. The data for create and update is provided via the `StepProcessorForm`.
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	canCreateStepProcessor
Description	Tests if this user can create step processors. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `StepProcessor` 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 `StepProcessor` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateStepProcessorWithRecordTypes
Description	Tests if this user can create a single `StepProcessor` using the desired record types. While `WorkflowRulesManager.getStepProcessorRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `StepProcessor`. Providing an empty array tests if a `StepProcessor` can be created with no records.
Parameters	`osid.type.Type[]`	`stepProcessorRecordTypes`	array of step processor record types
Return	`boolean`		`true` if `StepProcessor` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`stepProcessorRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getStepProcessorFormForCreate
Description	Gets the step processor form for creating new step processors. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`stepProcessorRecordTypes`	array of step processor record types
Return	`osid.workflow.rules.StepProcessorForm`		the step processor form
Errors	NULL_ARGUMENT		`stepProcessorRecordTypes` 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	createStepProcessor
Description	Creates a new `StepProcessor`.
Parameters	`osid.workflow.rules.StepProcessorForm`	`stepProcessorForm`	the form for this `StepProcessor`
Return	`osid.workflow.rules.StepProcessor`		the new `StepProcessor`
Errors	ILLEGAL_STATE		`stepProcessorForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`stepProcessorForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`stepProcessorForm did not originate from getStepProcessorFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateStepProcessors
Description	Tests if this user can update step processors. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `StepProcessor` 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 `StepProcessor` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getStepProcessorFormForUpdate
Description	Gets the step processor form for updating an existing step processor. A new step processor form should be requested for each update transaction.
Parameters	`osid.id.Id`	`stepProcessorId`	the `Id` of the `StepProcessor`
Return	`osid.workflow.rules.StepProcessorForm`		the step processor form
Errors	NOT_FOUND		`stepProcessorId` is not found
	NULL_ARGUMENT		`stepProcessorId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateStepProcessor
Description	Updates an existing step processor.
Parameters	`osid.workflow.rules.StepProcessorForm`	`stepProcessorForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`stepProcessorForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`stepProcessorForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`stepProcessorForm did not originate from getStepProcessorFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteStepProcessors
Description	Tests if this user can delete step processors. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `StepProcessor` 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 `StepProcessor` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteStepProcessor
Description	Deletes a `StepProcessor`.
Parameters	`osid.id.Id`	`stepProcessorId`	the `Id` of the `StepProcessor` to remove
Errors	NOT_FOUND		`stepProcessorId` not found
	NULL_ARGUMENT		`stepProcessorId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageStepProcessorAliases
Description	Tests if this user can manage `Id` aliases for step processors. 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 `StepProcessor` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasStepProcessor
Description	Adds a `Id` to a `StepProcessor` for the purpose of creating compatibility. The primary `Id` of the `StepProcessor` 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 processor. it is reassigned to the given step processor `Id`.
Parameters	`osid.id.Id`	`stepProcessorId`	the `Id` of a `StepProcessor`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`stepProcessorId` not found
	NULL_ARGUMENT		`stepProcessorId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.