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

Interface	osid.workflow.rules.StepConstrainerEnablerRuleLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods to retrieve `StepConstrainerEnabler` to `StepConstrainer` mappings. a `Step` with multiple `StepConstrainerEnablers` means any positive rule evaluation across the enablers result in an effective `StepConstrainer.` 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 step constrainer enablers defined explicitly in the current office federated office view: All methods in this session operate, retrieve and pertain to all step constrainer enablers defined in this office and any other step constrainer 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	canLookupStepConstrainerEnablerRules
Description	Tests if this user can perform lookups of step constrainer enabler/step constrainer 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	useComparativeStepConstrainerEnablerRuleView
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	usePlenaryStepConstrainerEnablerRuleView
Description	A complete view of the `StepConstrainerEnabler` and `StepConstrainer` 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 constrainer 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	getStepConstrainerEnablerIdsForStepConstrainer
Description	Gets the `StepConstrainerEnabler Id` associated with a `StepConstrainer.`
Parameters	`osid.id.Id`	`stepConstrainerId`	`Id` of the `StepConstrainer`
Return	`osid.id.IdList`		the step constrainer enabler `Ids`
Errors	NOT_FOUND		`stepConstrainerId` is not found
	NULL_ARGUMENT		`stepConstrainerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getStepConstrainerEnablersForStepConstrainer
Description	Gets the `StepConstrainerEnablers` associated with a `StepConstrainer.`
Parameters	`osid.id.Id`	`stepConstrainerId`	`Id` of the `StepConstrainer`
Return	`osid.workflow.rules.StepConstrainerEnablerList`		the step constrainer enablers
Errors	NOT_FOUND		`stepConstrainerId` is not found
	NULL_ARGUMENT		`stepConstrainerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getStepConstrainerIdsForStepConstrainerEnabler
Description	Gets the `StepConstrainer` `Ids` mapped to a `StepConstrainerEnabler.`
Parameters	`osid.id.Id`	`stepConstrainerEnablerId`	`Id` of a `StepConstrainerEnabler`
Return	`osid.id.IdList`		list of step constrainer `Ids`
Errors	NOT_FOUND		`stepConstrainerEnablerId` is not found
	NULL_ARGUMENT		`stepConstrainerEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getStepConstrainersForStepConstrainerEnabler
Description	Gets the `StepConstrainers` mapped to a `StepConstrainerEnabler.`
Parameters	`osid.id.Id`	`stepConstrainerEnablerId`	`Id` of a `StepConstrainerEnabler`
Return	`osid.workflow.rules.StepConstrainerList`		list of step constrainers
Errors	NOT_FOUND		`stepConstrainerEnablerId` is not found
	NULL_ARGUMENT		`stepConstrainerEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.