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

Interface	osid.workflow.rules.StepProcessorEnablerRuleApplicationSession
Implements	`osid.OsidSession`
Description	This session provides methods to apply `StepProcessorEnablers` to `StepProcessors.` a `StepProcessor` with multiple `StepProcessorEnablers` means any positive rule evaluation across the enablers result in an effective `StepProcessor.`
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	canAssignStepProcessorEnablers
Description	Tests if this user can alter step processor enabler/step 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	assignStepProcessorEnablerToStepProcessor
Description	Adds an existing `StepProcessorEnabler` to a `StepProcessor.`
Parameters	`osid.id.Id`	`stepProcessorEnablerId`	the `Id` of the `StepProcessorEnabler`
Parameters	`osid.id.Id`	`stepProcessorId`	the `Id` of the `StepProcessor`
Errors	ALREADY_EXISTS		`stepProcessorEnablerId` is already applied to `stepProcessorId`
	NOT_FOUND		`stepProcessorEnablerId` or `stepProcessorId` not found
	NULL_ARGUMENT		`stepProcessorEnablerId` or `stepProcessorId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	unassignStepProcessorEnablerFromStepProcessor
Description	Removes a `StepProcessorEnabler` from a `StepProcessor.`
Parameters	`osid.id.Id`	`stepProcessorEnablerId`	the `Id` of the `StepProcessorEnabler`
Parameters	`osid.id.Id`	`stepProcessorId`	the `Id` of the `StepProcessor`
Errors	NOT_FOUND		`stepProcessorEnablerId` or `stepProcessorId` not found or `stepProcessorEnablerId` not applied to `stepProcessorId`
	NULL_ARGUMENT		`stepProcessorEnablerId` or `stepProcessorId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSequenceStepProcessorEnablers
Description	Tests if this user can order `StepProcessorEnablers.` 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 `StepProcessorEnabler` ordering is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	moveStepProcessorEnablerAhead
Description	Reorders step processor enablers for a step processor by moving the specified step processor enabler in front of a reference step processor enabler.
Parameters	`osid.id.Id`	`stepProcessorEnablerId`	the `Id` of a `StepProcessorEnabler`
	`osid.id.Id`	`stepProcessorId`	the `Id` of a `StepProcessor`
	`osid.id.Id`	`referenceId`	the reference step processor enabler `Id`
Errors	NOT_FOUND		`stepProcessorEnablerId, stepProcessorId,` or `referenceId` not found or, `stepProcessorEnablerId` or `referenceId` not related to `stepProcessorId`
	NULL_ARGUMENT		`stepProcessorEnablerId, stepProcessorId,` or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	moveStepProcessorEnablerBehind
Description	Reorders step processor enablers for a step processor by moving the specified step processor enabler behind a reference step processor enabler.
Parameters	`osid.id.Id`	`stepProcessorEnablerId`	the `Id` of a `StepProcessorEnabler`
	`osid.id.Id`	`stepProcessorId`	the `Id` of a `StepProcessor`
	`osid.id.Id`	`referenceId`	the reference step processor enabler `Id`
Errors	NOT_FOUND		`stepProcessorEnablerId, stepProcessorId,` or `referenceId` not found or, `stepProcessorEnablerId` or `referenceId` not related to `stepProcessorId`
	NULL_ARGUMENT		`stepProcessorEnablerId, stepProcessorId,` or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	orderStepProcessorEnablers
Description	Reorders a set of step processor enablers for a step processor.
Parameters	`osid.id.Id[]`	`stepProcessorEnablerIds`	the `Ids` for a set of `StepProcessorEnablers`
Parameters	`osid.id.Id`	`stepProcessorId`	the `Id` of a `StepProcessor`
Errors	NOT_FOUND		`stepProcessorId` not found or, an `stepProcessorEnablerId` not related to `stepProcessorId`
	NULL_ARGUMENT		`stepProcessorEnablerIds` or `stepProcessorId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.