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

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