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

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