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

Interface	osid.workflow.rules.ProcessConstrainerAdminSession
Implements	`osid.OsidSession`
Used By	`osid.workflow.rules.WorkflowRulesManager`
Used By	`osid.workflow.rules.WorkflowRulesProxyManager`
Description	This session creates, updates, and deletes `ProcessConstrainers` . 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 `ProcessConstrainer` , a `ProcessConstrainerForm` is requested using `getProcessConstrainerFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `ProcessConstrainerForm` 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 `ProcessConstrainerForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `ProcessConstrainerForm` corresponds to an attempted transaction. For updates, `ProcessConstrainerForms` are requested to the `ProcessConstrainer` `Id` that is to be updated using `getProcessConstrainerFormForUpdate()` . Similarly, the `ProcessConstrainerForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `ProcessConstrainerForm` can only be used once for a successful update and cannot be reused. The delete operations delete `ProcessConstrainers` . To unmap a `ProcessConstrainer` from the current `Office` , the `ProcessConstrainerOfficeAssignmentSession` should be used. These delete operations attempt to remove the `ProcessConstrainer` 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	canCreateProcessConstrainers
Description	Tests if this user can create `ProcessConstrainers` . A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `ProcessConstrainer` 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 `ProcessConstrainer` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateProcessConstrainerWithRecordTypes
Description	Tests if this user can create a single `ProcessConstrainer` using the desired record types. While `WorkflowRulesManager.getProcessConstrainerRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `ProcessConstrainer` . Providing an empty array tests if a `ProcessConstrainer can be` created with no records.
Parameters	`osid.type.Type[]`	`processConstrainerRecordTypes`	array of process constrainer record types
Return	`boolean`		`true` if `ProcessConstrainer` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`processConstrainerRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getProcessConstrainerFormForCreate
Description	Gets the process constrainer form for creating new process constrainers. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`processConstrainerRecordTypes`	array of process constrainer record types
Return	`osid.workflow.rules.ProcessConstrainerForm`		the process constrainer form
Errors	NULL_ARGUMENT		`processConstrainerRecordTypes` 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	createProcessConstrainer
Description	Creates a new `ProcessConstrainer` .
Parameters	`osid.workflow.rules.ProcessConstrainerForm`	`processConstrainerForm`	the form for this `ProcessConstrainer`
Return	`osid.workflow.rules.ProcessConstrainer`		the new `ProcessConstrainer`
Errors	ILLEGAL_STATE		`processConstrainerForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`processConstrainerForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`processConstrainerForm` did not originate from `getProcessConstrainerFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateProcessConstrainers
Description	Tests if this user can update `ProcessConstrainers` . A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `ProcessConstrainer` 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 `ProcessConstrainer` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getProcessConstrainerFormForUpdate
Description	Gets the process constrainer form for updating an existing process constrainer. A new process constrainer form should be requested for each update transaction.
Parameters	`osid.id.Id`	`processConstrainerId`	the `Id` of the `ProcessConstrainer`
Return	`osid.workflow.rules.ProcessConstrainerForm`		the process form
Errors	NOT_FOUND		`processConstrainerId` is not found
	NULL_ARGUMENT		`processConstrainerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateProcessConstrainer
Description	Updates an existing process constrainer.
Parameters	`osid.workflow.rules.ProcessConstrainerForm`	`processConstrainerForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`processConstrainerForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`processConstrainerForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`processConstrainerForm` did not originate from `getProcessConstrainerFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteProcessConstrainers
Description	Tests if this user can delete `ProcessConstrainers` . A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `ProcessConstrainer` 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 `ProcessConstrainer` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteProcessConstrainer
Description	Deletes a `ProcessConstrainer` .
Parameters	`osid.id.Id`	`processConstrainerId`	the `Id` of the `ProcessConstrainer` to remove
Errors	NOT_FOUND		`processConstrainerId` not found
	NULL_ARGUMENT		`processConstrainerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageProcessConstrainerAliases
Description	Tests if this user can manage `Id` aliases for `ProcessConstrainers` 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 `ProcessConstrainer` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasProcessConstrainer
Description	Adds an `Id` to a `ProcessConstrainer` for the purpose of creating compatibility. The primary `Id` of the `ProcessConstrainer` is determined by the provider. The new `Id` performs as an alias to the primary `Id` . If the alias is a pointer to another process constrainer, it is reassigned to the given process constrainer Id.
Parameters	`osid.id.Id`	`processConstrainerId`	the `Id` of a `ProcessConstrainer`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`processConstrainerId` not found
	NULL_ARGUMENT		`processConstrainerId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.