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

Interface	osid.assessment.authoring.SequenceRuleQuerySession
Implements	`osid.OsidSession`
Implemented By	`osid.assessment.authoring.SequenceRuleSearchSession`
Used By	`osid.assessment.authoring.AssessmentAuthoringManager`
Used By	`osid.assessment.authoring.AssessmentAuthoringProxyManager`
Description	This session provides methods for searching among `SequenceRule` objects. The search query is constructed using the `SequenceRuleQuery`. This session defines views that offer differing behaviors for searching. federated bank view: searches include sequence rule in bank of which this bank is an ancestor in the bank hierarchy isolated bank view: searches are restricted to sequence rule in this bank sequence rule may have a query record indicated by their respective record types. The query record is accessed via the `SequenceRuleQuery`.
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	canSearchSequenceRules
Description	Tests if this user can perform `SequenceRule` lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may not offer lookup operations to unauthorized users.
Return	`boolean`		`false` if search methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useFederatedBankView
Description	Federates the view for methods in this session. A federated view will include sequence rule in banks which are children of this step 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	getSequenceRuleQuery
Description	Gets a sequence rule query.
Return	`osid.assessment.authoring.SequenceRuleQuery`		the sequence rule query
Compliance	`mandatory`		This method must be implemented.
Method	getSequenceRulesByQuery
Description	Gets a list of `SequenceRules` matching the given sequence rule query.
Parameters	`osid.assessment.authoring.SequenceRuleQuery`	`sequenceRuleQuery`	the sequence rule query
Return	`osid.assessment.authoring.SequenceRuleList`		the returned `SequenceRuleList`
Errors	NULL_ARGUMENT		`sequenceRuleQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`sequenceRuleQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.