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

Interface	osid.workflow.rules.StepProcessorRuleApplicationSession
Implements	`osid.OsidSession`
Used By	`osid.workflow.rules.WorkflowRulesManager`
Used By	`osid.workflow.rules.WorkflowRulesProxyManager`
Description	This session provides methods to apply `StepProcessors` to `Steps` .
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	canAssignStepProcessors
Description	Tests if this user can alter step processor/step 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	assignStepProcessorToStep
Description	Adds an existing `StepProcessor` to a `Step` .
Parameters	`osid.id.Id`	`stepProcessorId`	the `Id` of the `StepProcessor`
Parameters	`osid.id.Id`	`stepId`	the `Id` of the `Step`
Errors	ALREADY_EXISTS		`stepProcessorId` is already applied to `stepId`
	NOT_FOUND		`stepProcessorId` or `stepId` not found
	NULL_ARGUMENT		`stepProcessorId` or `stepId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	unassignStepProcessorFromStep
Description	Removes a `StepProcessor` from a `Step` .
Parameters	`osid.id.Id`	`stepProcessorId`	the `Id` of the `StepProcessor`
Parameters	`osid.id.Id`	`stepId`	the `Id` of the `Step`
Errors	NOT_FOUND		`stepProcessorId` or `stepId` not found or `stepProcessorId` not applied to `stepId`
	NULL_ARGUMENT		`stepProcessorId` or `stepId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSequenceStepProcessors
Description	Tests if this user can order `StepProcessors` . 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 `StepProcessor` ordering is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	moveStepProcessorAhead
Description	Reorders step processors for a step by moving the specified step processors in front of a reference step processors.
Parameters	`osid.id.Id`	`stepProcessorId`	the `Id` of a `StepProcessor`
	`osid.id.Id`	`stepId`	the `Id` of a `Step`
	`osid.id.Id`	`referenceId`	the reference step processor `Id`
Errors	NOT_FOUND		`stepProcessorId, stepId` , or `referenceId` not found or, `stepProcessorId` or `referenceId` not related to `stepId`
	NULL_ARGUMENT		`stepProcessorId, stepId` , or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	moveStepProcessorBehind
Description	Reorders step processors for a step by moving the specified step processors behind a reference step processors.
Parameters	`osid.id.Id`	`stepProcessorId`	the `Id` of a `StepProcessor`
	`osid.id.Id`	`stepId`	the `Id` of a `Step`
	`osid.id.Id`	`referenceId`	the reference step processor `Id`
Errors	NOT_FOUND		`stepProcessorId, stepId` , or `referenceId` not found or, `stepProcessorId` or `referenceId` not related to `stepId`
	NULL_ARGUMENT		`stepProcessorId, stepId` , or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	orderStepProcessors
Description	Reorders a set of step processors for a step.
Parameters	`osid.id.Id[]`	`stepProcessorIds`	the `Ids` for a set of `StepProcessors`
Parameters	`osid.id.Id`	`stepId`	the `Id` of a `Step`
Errors	NOT_FOUND		`stepId` not found or, an `stepProcessorId` not related to `stepId`
	NULL_ARGUMENT		`stepProcessorIds` or `stepId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.