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

Interface	osid.workflow.rules.StepConstrainerEnablerRuleApplicationSession
Implements	`osid.OsidSession`
Used By	`osid.workflow.rules.WorkflowRulesManager`
Used By	`osid.workflow.rules.WorkflowRulesProxyManager`
Description	This session provides methods to apply `StepConstrainerEnablers` to `StepConstrainers`. a `StepConstrainer` with multiple `StepConstrainerEnablers` means any positive rule evaluation across the enablers result in an effective `StepConstrainer`.
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	canAssignStepConstrainerEnablers
Description	Tests if this user can alter step constrainer enabler/step 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	assignStepConstrainerEnablerToStepConstrainer
Description	Adds an existing `StepConstrainerEnabler` to a `StepConstrainer`.
Parameters	`osid.id.Id`	`stepConstrainerEnablerId`	the `Id` of the `StepConstrainerEnabler`
Parameters	`osid.id.Id`	`stepConstrainerId`	the `Id` of the `StepConstrainer`
Errors	ALREADY_EXISTS		`stepConstrainerEnablerId` is already applied to `stepConstrainerId`
	NOT_FOUND		`stepConstrainerEnablerId` or `stepConstrainerId` not found
	NULL_ARGUMENT		`stepConstrainerEnablerId` or `stepConstrainerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	unassignStepConstrainerEnablerFromStepConstrainer
Description	Removes a `StepConstrainerEnabler` from a `StepConstrainer`.
Parameters	`osid.id.Id`	`stepConstrainerEnablerId`	the `Id` of the `StepConstrainerEnabler`
Parameters	`osid.id.Id`	`stepConstrainerId`	the `Id` of the `StepConstrainer`
Errors	NOT_FOUND		`stepConstrainerEnablerId` or `stepConstrainerId` not found or `stepConstrainerEnablerId` not applied to `stepConstrainerId`
	NULL_ARGUMENT		`stepConstrainerEnablerId` or `stepConstrainerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSequenceStepConstrainerEnablers
Description	Tests if this user can order `StepConstrainerEnablers`. 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 `StepConstrainerEnabler` ordering is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	moveStepConstrainerEnablerAhead
Description	Reorders step constrainer enablers for a step constrainer by moving the specified step constrainer enabler in front of a reference step constrainer enabler.
Parameters	`osid.id.Id`	`stepConstrainerEnablerId`	the `Id` of a `StepConstrainerEnabler`
	`osid.id.Id`	`stepConstrainerId`	the `Id` of a `StepConstrainer`
	`osid.id.Id`	`referenceId`	the reference step constrainer enabler `Id`
Errors	NOT_FOUND		`stepConstrainerEnablerId, stepConstrainerId`, or `referenceId` not found or, `stepConstrainerEnablerId` or `referenceId` not related to `stepConstrainerId`
	NULL_ARGUMENT		`stepConstrainerEnablerId, stepConstrainerId`, or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	moveStepConstrainerEnablerBehind
Description	Reorders step constrainer enablers for a step constrainer by moving the specified step constrainer enabler behind a reference step constrainer enabler.
Parameters	`osid.id.Id`	`stepConstrainerEnablerId`	the `Id` of a `StepConstrainerEnabler`
	`osid.id.Id`	`stepConstrainerId`	the `Id` of a `StepConstrainer`
	`osid.id.Id`	`referenceId`	the reference step constrainer enabler `Id`
Errors	NOT_FOUND		`stepConstrainerEnablerId, stepConstrainerId`, or `referenceId` not found or, `stepConstrainerEnablerId` or `referenceId` not related to `stepConstrainerId`
	NULL_ARGUMENT		`stepConstrainerEnablerId, stepConstrainerId`, or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	orderStepConstrainerEnablers
Description	Reorders a set of step constrainer enablers for a step constrainer.
Parameters	`osid.id.Id[]`	`stepConstrainerEnablerIds`	the `Ids` for a set of `StepConstrainerEnablers`
Parameters	`osid.id.Id`	`stepConstrainerId`	the `Id` of a `StepConstrainer`
Errors	NOT_FOUND		`stepConstrainerId` not found or, an `stepConstrainerEnablerId` not related to `stepConstrainerId`
	NULL_ARGUMENT		`stepConstrainerEnablerIds` or `stepConstrainerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.