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

Interface	osid.workflow.rules.ProcessProcessorEnablerRuleApplicationSession
Implements	`osid.OsidSession`
Used By	`osid.workflow.rules.WorkflowRulesManager`
Used By	`osid.workflow.rules.WorkflowRulesProxyManager`
Description	This session provides methods to apply `ProcessProcessorEnablers` to `ProcessProcessors`. Multiple `ProcessProcessorEnablers` applied to an `ProcessProcessor` may be sequenced such that the first positive evaluation results in the `ProcessProcessorEnabler` 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	canAssignProcessProcessorEnablers
Description	Tests if this user can alter process processor enabler/process processor 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	assignProcessProcessorEnablerToProcessProcessor
Description	Adds an existing `ProcessProcessorEnabler` to a `ProcessProcessor`.
Parameters	`osid.id.Id`	`processProcessorEnablerId`	the `Id` of the `ProcessProcessorEnabler`
Parameters	`osid.id.Id`	`processProcessorId`	the `Id` of the `ProcessProcessor`
Errors	ALREADY_EXISTS		`processProcessorEnablerId` already applied to `processProcessorId`
	NOT_FOUND		`processProcessorEnablerId` or `processProcessorId` not found
	NULL_ARGUMENT		`processProcessorEnablerId` or `processProcessorId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	unassignProcessProcessorEnablerFromProcessProcessor
Description	Removes an existing `ProcessProcessorEnabler` from a `ProcessProcessor`.
Parameters	`osid.id.Id`	`processProcessorEnablerId`	the `Id` of the `ProcessProcessorEnabler`
Parameters	`osid.id.Id`	`processProcessorId`	the `Id` of the `ProcessProcessor`
Errors	NOT_FOUND		`processProcessorEnablerId` or `processProcessorId` not found or `processProcessorEnablerId` already applied to `processProcessorId`
	NULL_ARGUMENT		`processProcessorEnablerId` or `processProcessorId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSequenceProcessProcessorEnablers
Description	Tests if this user can order `ProcessProcessorEnablers`. 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 `ProcessProcessorEnabler` ordering is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	moveProcessProcessorEnablerAhead
Description	Reorders process processor enablers for a process processor by moving the specified process processor enabler in front of a reference process processor enabler.
Parameters	`osid.id.Id`	`processProcessorEnablerId`	the `Id` of the `ProcessProcessorEnabler`
	`osid.id.Id`	`processProcessorId`	the `Id` of the `ProcessProcessor`
	`osid.id.Id`	`referenceId`	the reference process processor enabler `Id`
Errors	NOT_FOUND		`processProcessorEnablerId processProcessorId`, or `referenceId` not found or, `processProcessorEnablerId` or `referenceId` not related to `processProcessorId`
	NULL_ARGUMENT		`processProcessorEnablerId, processProcessorId`, or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	moveProcessProcessorEnablerBehind
Description	Reorders process processor enablers for a process processor by moving the specified process processor enabler behind a reference process processor enabler.
Parameters	`osid.id.Id`	`processProcessorEnablerId`	the `Id` of the `ProcessProcessorEnabler`
	`osid.id.Id`	`processProcessorId`	the `Id` of the `ProcessProcessor`
	`osid.id.Id`	`referenceId`	the reference process processor `Id`
Errors	NOT_FOUND		`processProcessorEnablerId processProcessorId`, or `referenceId` not found or, `processProcessorEnablerId` or `referenceId` not related to `processProcessorId`
	NULL_ARGUMENT		`processProcessorEnablerId, processProcessorId`, or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	orderProcessProcessorEnablers
Description	Reorders a set of process processor enablers for a process processor.
Parameters	`osid.id.Id[]`	`processProcessorEnablerIds`	the `Ids` for a set of `ProcessProcessorEnablers`
Parameters	`osid.id.Id`	`processProcessorId`	the `Id` of the `ProcessProcessor`
Errors	NOT_FOUND		`processProcessorId` not found or, a `processProcessorEnablerId` not related to `processProcessorId`
	NULL_ARGUMENT		`processProcessorEnablerIds` or `processProcessorId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.