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

Interface	osid.workflow.rules.ProcessProcessorRuleApplicationSession
Implements	`osid.OsidSession`
Used By	`osid.workflow.rules.WorkflowRulesManager`
Used By	`osid.workflow.rules.WorkflowRulesProxyManager`
Description	This session provides methods to apply `ProcessProcessors` to `Processes` . Multiple `ProcessProcessors` applied to an `Process` may be sequenced such that the first positive evaluation results in the `ProcessProcessor` used.
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	canAssignProcessProcessors
Description	Tests if this user can alter process processor/process mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping methods in this session will result in a `PERMISSION_DENIED` . This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.
Return	`boolean`		`false` if mapping is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	assignProcessProcessorToProcess
Description	Adds an existing `ProcessProcessor` to a `Process` .
Parameters	`osid.id.Id`	`processProcessorId`	the `Id` of the `ProcessProcessor`
Parameters	`osid.id.Id`	`processId`	the `Id` of the `Process`
Errors	ALREADY_EXISTS		`processProcessorId` already applied to `processId`
	NOT_FOUND		`processProcessorId` or `processId` not found
	NULL_ARGUMENT		`processProcessorId` or `processId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	unassignProcessProcessorFromProcess
Description	Removes an existing `ProcessProcessor` from a `Process` .
Parameters	`osid.id.Id`	`processProcessorId`	the `Id` of the `ProcessProcessor`
Parameters	`osid.id.Id`	`processId`	the `Id` of the `Process`
Errors	NOT_FOUND		`processProcessorId` or `processId` not found or `processProcessorId` already applied to `processId`
	NULL_ARGUMENT		`processProcessorId` or `processId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSequenceProcessProcessors
Description	Tests if this user can order `ProcessProcessors` . A return of true does not guarantee successful authorization. A return of false indicates that it is known sequencing operations will result in a `PERMISSION_DENIED` .This is intended as a hint to an application that may opt not to offer sequencing operations to an unauthorized user.
Return	`boolean`		`false` if `ProcessProcessor` ordering is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	moveProcessProcessorAhead
Description	Reorders process processors for a process by moving the specified process processor in front of a reference process processor.
Parameters	`osid.id.Id`	`processProcessorId`	the `Id` of the `ProcessProcessor`
	`osid.id.Id`	`processId`	the `Id` of the `Process`
	`osid.id.Id`	`referenceId`	the reference process processor `Id`
Errors	NOT_FOUND		`processProcessorId processId` , or `referenceId` not found or, `processProcessorId` or `referenceId` not related to `processId`
	NULL_ARGUMENT		`processProcessorId, processId` , or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	moveProcessProcessorBehind
Description	Reorders process processors for a process by moving the specified process processor behind a reference process processor.
Parameters	`osid.id.Id`	`processProcessorId`	the `Id` of the `ProcessProcessor`
	`osid.id.Id`	`processId`	the `Id` of the `Process`
	`osid.id.Id`	`referenceId`	the reference process processor `Id`
Errors	NOT_FOUND		`processProcessorId, processId` , or `referenceId` not found or, `processProcessorId` or `referenceId` not related to `processId`
	NULL_ARGUMENT		`processProcessorId, processId` , or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	orderProcessProcessors
Description	Reorders a set of process processors for a process.
Parameters	`osid.id.Id[]`	`processProcessorIds`	the `Ids` for a set of `ProcessProcessors`
Parameters	`osid.id.Id`	`processId`	the `Id` of the `Process`
Errors	NOT_FOUND		`processId` not found or, a `processProcessorId` not related to `processId`
	NULL_ARGUMENT		`processProcessorIds` or `processId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.