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

Interface	osid.workflow.rules.ProcessConstrainerEnablerRuleApplicationSession
Implements	`osid.OsidSession`
Used By	`osid.workflow.rules.WorkflowRulesManager`
Used By	`osid.workflow.rules.WorkflowRulesProxyManager`
Description	This session provides methods to apply `ProcessConstrainerEnablers` to `ProcessConstrainers`. Multiple `ProcessConstrainerEnablers` applied to an `ProcessConstrainer` may be sequenced such that the first positive evaluation results in the `ProcessConstrainerEnabler` 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	canAssignProcessConstrainerEnablers
Description	Tests if this user can alter process constrainer enabler/process constrainer 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	assignProcessConstrainerEnablerToProcessConstrainer
Description	Adds an existing `ProcessConstrainerEnabler` to a `ProcessConstrainer`.
Parameters	`osid.id.Id`	`processConstrainerEnablerId`	the `Id` of the `ProcessConstrainerEnabler`
Parameters	`osid.id.Id`	`processConstrainerId`	the `Id` of the `ProcessConstrainer`
Errors	ALREADY_EXISTS		`processConstrainerEnablerId` already applied to `processConstrainerId`
	NOT_FOUND		`processConstrainerEnablerId` or `processConstrainerId` not found
	NULL_ARGUMENT		`processConstrainerEnablerId` or `processConstrainerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	unassignProcessConstrainerEnablerFromProcessConstrainer
Description	Removes an existing `ProcessConstrainerEnabler` from a `ProcessConstrainer`.
Parameters	`osid.id.Id`	`processConstrainerEnablerId`	the `Id` of the `ProcessConstrainerEnabler`
Parameters	`osid.id.Id`	`processConstrainerId`	the `Id` of the `ProcessConstrainer`
Errors	NOT_FOUND		`processConstrainerEnablerId` or `processConstrainerId` not found or `processConstrainerEnablerId` already applied to `processConstrainerId`
	NULL_ARGUMENT		`processConstrainerEnablerId` or `processConstrainerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSequenceProcessConstrainerEnablers
Description	Tests if this user can order `ProcessConstrainerEnablers`. 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 `ProcessConstrainerEnabler` ordering is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	moveProcessConstrainerEnablerAhead
Description	Reorders process constrainer enablers for a process constrainer by moving the specified process constrainer enabler in front of a reference process constrainer enabler.
Parameters	`osid.id.Id`	`processConstrainerEnablerId`	the `Id` of the `ProcessConstrainerEnabler`
	`osid.id.Id`	`processConstrainerId`	the `Id` of the `ProcessConstrainer`
	`osid.id.Id`	`referenceId`	the reference process constrainer enabler `Id`
Errors	NOT_FOUND		`processConstrainerEnablerId processConstrainerId`, or `referenceId` not found or, `processConstrainerEnablerId` or `referenceId` not related to `processConstrainerId`
	NULL_ARGUMENT		`processConstrainerEnablerId, processConstrainerId`, or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	moveProcessConstrainerEnablerBehind
Description	Reorders process constrainer enablers for a process constrainer by moving the specified process constrainer enabler behind a reference process constrainer enabler.
Parameters	`osid.id.Id`	`processConstrainerEnablerId`	the `Id` of the `ProcessConstrainerEnabler`
	`osid.id.Id`	`processConstrainerId`	the `Id` of the `ProcessConstrainer`
	`osid.id.Id`	`referenceId`	the reference process constrainer `Id`
Errors	NOT_FOUND		`processConstrainerEnablerId processConstrainerId`, or `referenceId` not found or, `processConstrainerEnablerId` or `referenceId` not related to `processConstrainerId`
	NULL_ARGUMENT		`processConstrainerEnablerId, processConstrainerId`, or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	orderProcessConstrainerEnablers
Description	Reorders a set of process constrainer enablers for a process constrainer.
Parameters	`osid.id.Id[]`	`processConstrainerEnablerIds`	the `Ids` for a set of `ProcessConstrainerEnablers`
Parameters	`osid.id.Id`	`processConstrainerId`	the `Id` of the `ProcessConstrainer`
Errors	NOT_FOUND		`processConstrainerId` not found or, a `processConstrainerEnablerId` not related to `processConstrainerId`
	NULL_ARGUMENT		`processConstrainerEnablerIds` or `processConstrainerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.