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

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