OSID - osid.assessment.authoring.SequenceRuleEnablerRuleLookupSession Service Interface Definition

Interface	osid.assessment.authoring.SequenceRuleEnablerRuleLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods to retrieve `SequenceRuleEnabler` to `SequenceRule` mappings. a `Step` with multiple `SequenceRuleEnablers` means any positive rule evaluation across the enablers result in an effective `SequenceRule.` 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 bank view: All methods in this session operate, retrieve and pertain sequence rule enablers defined explicitly in the current bank federated bank view: All methods in this session operate, retrieve and pertain to all sequence rule enablers defined in this bank and any other sequence rule enablers implicitly available in this bank through bank inheritence.
Method	getBankId
Description	Gets the `Bank` `Id` associated with this session.
Return	`osid.id.Id`		the `Bank Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getBank
Description	Gets the `Bank` associated with this session.
Return	`osid.assessment.Bank`		the bank
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canLookupSequenceRuleEnablerRules
Description	Tests if this user can perform lookups of sequence rule enabler/sequence rule 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	useComparativeSequenceRuleEnablerRuleView
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	usePlenarySequenceRuleEnablerRuleView
Description	A complete view of the `SequenceRuleEnabler` and `SequenceRule` 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	useFederatedBankView
Description	Federates the view for methods in this session. A federated view will include sequence rule enablers in banks which are children of this bank in the bank hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedBankView
Description	Isolates the view for methods in this session. An isolated view restricts lookups to this bank only.
Compliance	`mandatory`		This method is must be implemented.
Method	getSequenceRuleEnablerIdsForSequenceRule
Description	Gets the `SequenceRuleEnabler Id` associated with a `SequenceRule.`
Parameters	`osid.id.Id`	`sequenceRuleId`	`Id` of the `SequenceRule`
Return	`osid.id.IdList`		the sequence rule enabler `Ids`
Errors	NOT_FOUND		`sequenceRuleId` is not found
	NULL_ARGUMENT		`sequenceRuleId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getSequenceRuleEnablersForSequenceRule
Description	Gets the `SequenceRuleEnablers` associated with a `SequenceRule.`
Parameters	`osid.id.Id`	`sequenceRuleId`	`Id` of the `SequenceRule`
Return	`osid.assessment.authoring.SequenceRuleEnablerList`		the sequence rule enablers
Errors	NOT_FOUND		`sequenceRuleId` is not found
	NULL_ARGUMENT		`sequenceRuleId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getSequenceRuleIdsForSequenceRuleEnabler
Description	Gets the `SequenceRule` `Ids` mapped to a `SequenceRuleEnabler.`
Parameters	`osid.id.Id`	`sequenceRuleEnablerId`	`Id` of a `SequenceRuleEnabler`
Return	`osid.id.IdList`		list of sequence rule `Ids`
Errors	NOT_FOUND		`sequenceRuleEnablerId` is not found
	NULL_ARGUMENT		`sequenceRuleEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getSequenceRulesForSequenceRuleEnabler
Description	Gets the `SequenceRules` mapped to a `SequenceRuleEnabler.`
Parameters	`osid.id.Id`	`sequenceRuleEnablerId`	`Id` of a `SequenceRuleEnabler`
Return	`osid.assessment.authoring.SequenceRuleList`		list of sequence rules
Errors	NOT_FOUND		`sequenceRuleEnablerId` is not found
	NULL_ARGUMENT		`sequenceRuleEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.