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

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