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

Interface	osid.workflow.rules.StepConstrainerRuleApplicationSession
Implements	`osid.OsidSession`
Used By	`osid.workflow.rules.WorkflowRulesManager`
Used By	`osid.workflow.rules.WorkflowRulesProxyManager`
Description	This session provides methods to apply `StepConstrainers` to `Steps`. A `Step` with multiple `StepConstrainers` means any positive rule evaluation across the constrainers result in an accessible `Step`.
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	canAssignStepConstrainers
Description	Tests if this user can alter step constrainer/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	assignStepConstrainerToStep
Description	Adds an existing `StepConstrainer` to a `Step`.
Parameters	`osid.id.Id`	`stepConstrainerId`	the `Id` of the `StepConstrainer`
Parameters	`osid.id.Id`	`stepId`	the `Id` of the `Step`
Errors	ALREADY_EXISTS		`stepConstrainerId` is already applied to `stepId`
	NOT_FOUND		`stepConstrainerId` or `stepId` not found
	NULL_ARGUMENT		`stepConstrainerId` or `stepId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	unassignStepConstrainerFromStep
Description	Removes a `StepConstrainer` from a `Step`.
Parameters	`osid.id.Id`	`stepConstrainerId`	the `Id` of the `StepConstrainer`
Parameters	`osid.id.Id`	`stepId`	the `Id` of the `Step`
Errors	NOT_FOUND		`stepConstrainerId` or `stepId` not found or `stepConstrainerId` not applied to `stepId`
	NULL_ARGUMENT		`stepConstrainerId` or `stepId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSequenceStepConstrainers
Description	Tests if this user can order `StepConstrainers`. 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 `StepConstrainer` ordering is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	moveStepConstrainerAhead
Description	Reorders step constrainer for a step by moving the specified step constrainer in front of a reference step constrainer.
Parameters	`osid.id.Id`	`stepConstrainerId`	the `Id` of a `StepConstrainer`
	`osid.id.Id`	`stepId`	the `Id` of a `Step`
	`osid.id.Id`	`referenceId`	the reference step constrainer `Id`
Errors	NOT_FOUND		`stepConstrainerId, stepId` or `referenceId` not found or, `stepConstrainerId` or `referenceId` not related to `stepId`
	NULL_ARGUMENT		`stepConstrainerId, stepId` or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	moveStepConstrainerBehind
Description	Reorders step constrainer for a step by moving the specified step constrainer behind a reference step constrainer.
Parameters	`osid.id.Id`	`stepConstrainerId`	the `Id` of a `StepConstrainer`
	`osid.id.Id`	`stepId`	the `Id` of a `Step`
	`osid.id.Id`	`referenceId`	the reference step constrainer `Id`
Errors	NOT_FOUND		`stepConstrainerId, stepId` or `referenceId` not found or, `stepConstrainerId` or `referenceId` not related to `stepId`
	NULL_ARGUMENT		`stepConstrainerId, stepId` or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	orderStepConstrainers
Description	Reorders a set of step constrainers for a step.
Parameters	`osid.id.Id[]`	`stepConstrainerIds`	the `Ids` for a set of `StepConstrainers`
Parameters	`osid.id.Id`	`stepId`	the `Id` of a `StepConstrainer`
Errors	NOT_FOUND		`stepId` not found or, a `stepConstrainerId` not related to `stepId`
	NULL_ARGUMENT		`stepConstrainerIds` or `stepId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.