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

Interface	osid.workflow.rules.StepEnablerRuleApplicationSession
Implements	`osid.OsidSession`
Used By	`osid.workflow.rules.WorkflowRulesManager`
Used By	`osid.workflow.rules.WorkflowRulesProxyManager`
Description	This session provides methods to apply `StepEnablers` to `Steps` . Multiple `StepEnablers` applied to an `Step` may be sequenced such that the first positive evaluation results in the `StepEnablers` 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	canAssignStepEnablers
Description	Tests if this user can alter step enabler/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	assignStepEnablerToStep
Description	Adds an existing `StepEnabler` to a `Step` .
Parameters	`osid.id.Id`	`stepEnablerId`	the `Id` of the `StepEnabler`
Parameters	`osid.id.Id`	`stepId`	the `Id` of the `Step`
Errors	ALREADY_EXISTS		`stepEnablerId` already applied to `stepId`
	NOT_FOUND		`stepEnablerId` or `stepId` not found
	NULL_ARGUMENT		`stepEnablerId` or `stepId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	unassignStepEnablerFromStep
Description	Removes an existing `StepEnabler` from a `Step` .
Parameters	`osid.id.Id`	`stepEnablerId`	the `Id` of the `StepEnabler`
Parameters	`osid.id.Id`	`stepId`	the `Id` of the `Step`
Errors	NOT_FOUND		`stepEnablerId` or `stepId` not found or `stepEnablerId` already applied to `stepId`
	NULL_ARGUMENT		`stepEnablerId` or `stepId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSequenceStepEnablers
Description	Tests if this user can order `StepEnablers` . 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 `StepEnabler` ordering is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	moveStepEnablerAhead
Description	Reorders step enablers for a step by moving the specified step enabler in front of a reference step enabler.
Parameters	`osid.id.Id`	`stepEnablerId`	the `Id` of the `StepEnabler`
	`osid.id.Id`	`stepId`	the `Id` of the `Step`
	`osid.id.Id`	`referenceId`	the reference step enabler `Id`
Errors	NOT_FOUND		`stepEnablerId, stepId` , or `referenceId` not found or, `stepEnablerId` or `referenceId` not related to `stepId`
	NULL_ARGUMENT		`stepEnablerId, stepId` , or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	moveStepEnablerBehind
Description	Reorders step enablers for a step by moving the specified step enabler behind a reference step enabler.
Parameters	`osid.id.Id`	`stepEnablerId`	the `Id` of the `StepEnabler`
	`osid.id.Id`	`stepId`	the `Id` of the `Step`
	`osid.id.Id`	`referenceId`	the reference step enabler `Id`
Errors	NOT_FOUND		`stepEnablerId, stepId` , or `referenceId` not found or, `stepEnablerId` or `referenceId` not related to `stepId`
	NULL_ARGUMENT		`stepEnablerId, stepId` , or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	orderStepEnablers
Description	Reorders a set of step enablers for a step.
Parameters	`osid.id.Id[]`	`stepEnablerIds`	the `Ids` for a set of `StepEnablers`
Parameters	`osid.id.Id`	`stepId`	the `Id` of the `Step`
Errors	NOT_FOUND		`stepEnablerId, stepId` , or `referenceId` not found or, `stepEnablerId` or `referenceId` not related to `stepId`
	NULL_ARGUMENT		`stepEnablerIds, stepId` , or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.