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

Interface	osid.workflow.rules.StepEnablerRuleLookupSession
Implements	`osid.OsidSession`
Used By	`osid.workflow.rules.WorkflowRulesManager`
Used By	`osid.workflow.rules.WorkflowRulesProxyManager`
Description	This session provides methods to retrieve `StepEnabler` to `Step` mappings. This lookup session defines several views: comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete result set or is an error condition isolated office view: All methods in this session operate, retrieve and pertain to step enablers defined explicitly in the current office federated office view: All methods in this session operate, retrieve and pertain to all step enablers defined in this office and any other step enablers implicitly available in this office through office inheritence.
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	canLookupStepEnablerRules
Description	Tests if this user can perform lookups of step enabler/step mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 looking up mappings is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeStepEnablerRuleView
Description	The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.
Compliance	`mandatory`		This method is must be implemented.
Method	usePlenaryStepEnablerRuleView
Description	A complete view of the `StepEnabler` and `Step` returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.
Compliance	`mandatory`		This method is must be implemented.
Method	useFederatedOfficeView
Description	Federates the view for methods in this session. A federated view will include step enablers in offices which are children of this office in the office hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedOfficeView
Description	Isolates the view for methods in this session. An isolated view restricts lookups to this office only.
Compliance	`mandatory`		This method is must be implemented.
Method	getStepEnablerIdsForStep
Description	Gets the `StepEnabler Ids` associated with a `Step` .
Parameters	`osid.id.Id`	`stepId`	`Id` of the `Step`
Return	`osid.id.IdList`		the step enabler `Ids`
Errors	NOT_FOUND		`stepId` is not found
	NULL_ARGUMENT		`stepId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getStepEnablersForStep
Description	Gets the `StepEnablers` associated with a `Step` .
Parameters	`osid.id.Id`	`stepId`	`Id` of the `Step`
Return	`osid.workflow.rules.StepEnablerList`		the step enablers
Errors	NOT_FOUND		`stepId` is not found
	NULL_ARGUMENT		`stepId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getStepIdsForStepEnabler
Description	Gets the `Step` `Ids` mapped to a `StepEnabler` .
Parameters	`osid.id.Id`	`stepEnablerId`	`Id` of a `StepEnabler`
Return	`osid.id.IdList`		list of step `Ids`
Errors	NOT_FOUND		`stepEnablerId` is not found
	NULL_ARGUMENT		`stepEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getStepsForStepEnabler
Description	Gets the `Steps` mapped to a `StepEnabler` .
Parameters	`osid.id.Id`	`stepEnablerId`	`Id` of a `StepEnabler`
Return	`osid.workflow.StepList`		list of steps
Errors	NOT_FOUND		`stepEnablerId` is not found
	NULL_ARGUMENT		`stepEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.