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

Interface	osid.assessment.authoring.SequenceRuleSmartBankSession
Implements	`osid.OsidSession`
Used By	`osid.assessment.authoring.AssessmentAuthoringManager`
Used By	`osid.assessment.authoring.AssessmentAuthoringProxyManager`
Description	This session manages queries and sequencing to create "smart" dynamic bank. a `SequenceRuleQuery` can be retrieved from this session and mapped to this `Bank` to create a virtual collection of sequence rules. The sequence rule may be sequenced using the `SequenceRuleSearchOrder` from this session. This `Bank` has a default query that matches any sequence rule and a default search order that specifies no sequencing. The queries may be examined using a `SequenceRuleQueryInspector` . The query may be modified by converting the inspector back to a `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	canManageSmartBanks
Description	Tests if this user can manage smart bank. A return of true does not guarantee successful authorization. A return of false indicates that it is known 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 operations to unauthorized users.
Return	`boolean`		`false` if smart bank management is not authorized, `true` otherwise
Compliance	`mandatory`		This method 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	getSequenceRuleSearchOrder
Description	Gets a sequence rule search order.
Return	`osid.assessment.authoring.SequenceRuleSearchOrder`		the sequence rule search order
Compliance	`mandatory`		This method must be implemented.
Method	applySequenceRuleQuery
Description	Applies a sequence rule query to this bank.
Parameters	`osid.assessment.authoring.SequenceRuleQuery`	`sequenceRuleQuery`	the sequence rule query
Errors	NULL_ARGUMENT		`sequenceRuleQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`sequenceRuleQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectSequenceRuleQuery
Description	Gets a sequence rule query inspector for this bank.
Return	`osid.assessment.authoring.SequenceRuleQueryInspector`		the sequence rule query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applySequenceRuleSequencing
Description	Applies a sequence rule search order to this bank.
Parameters	`osid.assessment.authoring.SequenceRuleSearchOrder`	`sequenceRuleSearchOrder`	the sequence rule search order
Errors	NULL_ARGUMENT		`sequenceRuleSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`sequenceRuleSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getSequenceRuleQueryFromInspector
Description	Gets a sequence rule query from an inspector.
Parameters	`osid.assessment.authoring.SequenceRuleQueryInspector`	`sequenceRuleQueryInspector`	a sequence rule query inspector
Return	`osid.assessment.authoring.SequenceRuleQuery`		the sequence rule query
Errors	NULL_ARGUMENT		`sequenceRuleQueryInspector` is `null`
Errors	UNSUPPORTED		`sequenceRuleQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.