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

Interface	osid.workflow.rules.StepEnablerAdminSession
Implements	`osid.OsidSession`
Used By	`osid.workflow.rules.WorkflowRulesManager`
Used By	`osid.workflow.rules.WorkflowRulesProxyManager`
Description	This session creates, updates, and deletes `StepEnablers` . 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 `StepEnabler` , a `StepEnablerForm` is requested using `getStepEnablerFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `StepEnablerForm` 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 `StepEnablerForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `StepEnablerForm` corresponds to an attempted transaction. For updates, `StepEnablerForms` are requested to the `StepEnabler` `Id` that is to be updated using `getStepEnablerFormForUpdate()` . Similarly, the `StepEnablerForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `StepEnablerForm` can only be used once for a successful update and cannot be reused. The delete operations delete `StepEnablers` . To unmap a `StepEnabler` from the current `Office` , the `StepEnablerOfficeAssignmentSession` should be used. These delete operations attempt to remove the `StepEnabler` 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	canCreateStepEnablers
Description	Tests if this user can create `StepEnablers` . A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `StepEnabler` will result in a `PERMISSION_DENIED. T` his is intended as a hint to an application that may opt not to offer create operations to an unauthorized user.
Return	`boolean`		`false` if `StepEnabler` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateStepEnablerWithRecordTypes
Description	Tests if this user can create a single `StepEnabler` using the desired record types. While `WorkflowRulesManager.getStepEnablerRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `StepEnabler` . Providing an empty array tests if a `StepEnabler can be cre` ated with no records.
Parameters	`osid.type.Type[]`	`stepEnablerRecordTypes`	array of step enabler record types
Return	`boolean`		`true` if `StepEnabler` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`stepEnablerRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getStepEnablerFormForCreate
Description	Gets the step enabler form for creating new step enablers. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`stepEnablerRecordTypes`	array of step enabler record types
Return	`osid.workflow.rules.StepEnablerForm`		the step enabler form
Errors	NULL_ARGUMENT		`stepEnablerRecordTypes` 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	createStepEnabler
Description	Creates a new `StepEnabler` .
Parameters	`osid.workflow.rules.StepEnablerForm`	`stepEnablerForm`	the form for this `StepEnabler`
Return	`osid.workflow.rules.StepEnabler`		the new `StepEnabler`
Errors	ILLEGAL_STATE		`stepEnablerForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`stepEnablerForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`stepEnablerForm` did not originate from `getStepEnablerFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateStepEnablers
Description	Tests if this user can update `StepEnablers` . A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `StepEnabler` will result in a `PERMISSION_DENIED. T` his is intended as a hint to an application that may opt not to offer update operations to an unauthorized user.
Return	`boolean`		`false` if `StepEnabler` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getStepEnablerFormForUpdate
Description	Gets the step enabler form for updating an existing step enabler. A new step enabler form should be requested for each update transaction.
Parameters	`osid.id.Id`	`stepEnablerId`	the `Id` of the `StepEnabler`
Return	`osid.workflow.rules.StepEnablerForm`		the step enabler form
Errors	NOT_FOUND		`stepEnablerId` is not found
	NULL_ARGUMENT		`stepEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateStepEnabler
Description	Updates an existing step enabler.
Parameters	`osid.workflow.rules.StepEnablerForm`	`stepEnablerForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`stepEnablerForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`stepEnablerForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`stepEnablerForm` did not originate from `getStepEnablerFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteStepEnablers
Description	Tests if this user can delete `StepEnablers` . A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `StepEnabler` will result in a `PERMISSION_DENIED. T` his is intended as a hint to an application that may opt not to offer delete operations to an unauthorized user.
Return	`boolean`		`false` if `StepEnabler` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteStepEnabler
Description	Deletes a `StepEnabler` .
Parameters	`osid.id.Id`	`stepEnablerId`	the `Id` of the `StepEnabler` to remove
Errors	NOT_FOUND		`stepEnablerId` not found
	NULL_ARGUMENT		`stepEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageStepEnablerAliases
Description	Tests if this user can manage `Id` aliases for `StepEnablers` 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 `StepEnabler` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasStepEnabler
Description	Adds an `Id` to a `StepEnabler` for the purpose of creating compatibility. The primary `Id` of the `StepEnabler` 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 enabler, it is reassigned to the given step enabler `Id` .
Parameters	`osid.id.Id`	`stepEnablerId`	the `Id` of a `StepEnabler`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`stepEnablerId` not found
	NULL_ARGUMENT		`stepEnablerId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.