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

Interface	osid.workflow.rules.ProcessConstrainerRuleApplicationSession
Implements	`osid.OsidSession`
Used By	`osid.workflow.rules.WorkflowRulesManager`
Used By	`osid.workflow.rules.WorkflowRulesProxyManager`
Description	This session provides methods to apply `ProcessConstrainers` to `Processes`. Multiple `ProcessConstrainers` applied to an `Process` may be sequenced such that the first positive evaluation results in the `ProcessConstrainer` 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	canAssignProcessConstrainers
Description	Tests if this user can alter process constrainer/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	assignProcessConstrainerToProcess
Description	Adds an existing `ProcessConstrainer` to a `Process`.
Parameters	`osid.id.Id`	`processConstrainerId`	the `Id` of the `ProcessConstrainer`
Parameters	`osid.id.Id`	`processId`	the `Id` of the `Process`
Errors	ALREADY_EXISTS		`processConstrainerId` already applied to `processId`
	NOT_FOUND		`processConstrainerId` or `processId` not found
	NULL_ARGUMENT		`processConstrainerId` or `processId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	unassignProcessConstrainerFromProcess
Description	Removes an existing `ProcessConstrainer` from a `Process`.
Parameters	`osid.id.Id`	`processConstrainerId`	the `Id` of the `ProcessConstrainer`
Parameters	`osid.id.Id`	`processId`	the `Id` of the `Process`
Errors	NOT_FOUND		`processConstrainerId` or `processId` not found or `processConstrainerId` already applied to `processId`
	NULL_ARGUMENT		`processConstrainerId` or `processId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSequenceProcessConstrainers
Description	Tests if this user can order `ProcessConstrainers`. 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 `ProcessConstrainer` ordering is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	moveProcessConstrainerAhead
Description	Reorders process constrainers for a process by moving the specified process constrainer in front of a reference process constrainer.
Parameters	`osid.id.Id`	`processConstrainerId`	the `Id` of the `ProcessConstrainer`
	`osid.id.Id`	`processId`	the `Id` of the `Process`
	`osid.id.Id`	`referenceId`	the reference process constrainer `Id`
Errors	NOT_FOUND		`processConstrainerId, processId`, or `referenceId` not found or, `processConstrainerId` or `referenceId` not related to `processId`
	NULL_ARGUMENT		`processConstrainerId, processId`, or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	moveProcessConstrainerBehind
Description	Reorders process constrainers for a process by moving the specified process constrainer behind a reference process constrainer.
Parameters	`osid.id.Id`	`processConstrainerId`	the `Id` of the `ProcessConstrainer`
	`osid.id.Id`	`processId`	the `Id` of the `Process`
	`osid.id.Id`	`referenceId`	the reference process constrainer `Id`
Errors	NOT_FOUND		`processConstrainerId, processId`, or `referenceId` not found or, `processConstrainerId` or `referenceId` not related to `processId`
	NULL_ARGUMENT		`processConstrainerId, processId`, or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	orderProcessConstrainers
Description	Reorders a set of process constrainers for a process.
Parameters	`osid.id.Id[]`	`processConstrainerIds`	the `Ids` for a set of `ProcessConstrainers`
Parameters	`osid.id.Id`	`processId`	the `Id` of the `Process`
Errors	NOT_FOUND		`processId` not found or, a `processConstrainerId` not related to `processId`
	NULL_ARGUMENT		`processConstrainerIds` or `processId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.