OSID Logo
OSID Specifications
assessment authoring package
Version 3.0.0
Release Candidate Preview
Interfaceosid.assessment.authoring.SequenceRuleSmartBankSession
Implementsosid.OsidSession
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.

MethodgetBankId
Description

Gets the Bank Id associated with this session.

Returnosid.id.Idthe Bank Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetBank
Description

Gets the Bank associated with this session.

Returnosid.assessment.Bankthe bank
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanManageSmartBanks
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.

Returnboolean false if smart bank management is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetSequenceRuleQuery
Description

Gets a sequence rule query.

Returnosid.assessment.authoring.SequenceRuleQuerythe sequence rule query
CompliancemandatoryThis method must be implemented.
MethodgetSequenceRuleSearchOrder
Description

Gets a sequence rule search order.

Returnosid.assessment.authoring.SequenceRuleSearchOrderthe sequence rule search order
CompliancemandatoryThis method must be implemented.
MethodapplySequenceRuleQuery
Description

Applies a sequence rule query to this bank.

Parametersosid.assessment.authoring.SequenceRuleQuerysequenceRuleQuerythe sequence rule query
ErrorsNULL_ARGUMENT sequenceRuleQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED sequenceRuleQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectSequenceRuleQuery
Description

Gets a sequence rule query inspector for this bank.

Returnosid.assessment.authoring.SequenceRuleQueryInspectorthe sequence rule query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplySequenceRuleSequencing
Description

Applies a sequence rule search order to this bank.

Parametersosid.assessment.authoring.SequenceRuleSearchOrdersequenceRuleSearchOrderthe sequence rule search order
ErrorsNULL_ARGUMENT sequenceRuleSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED sequenceRuleSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetSequenceRuleQueryFromInspector
Description

Gets a sequence rule query from an inspector.

Parametersosid.assessment.authoring.SequenceRuleQueryInspectorsequenceRuleQueryInspectora sequence rule query inspector
Returnosid.assessment.authoring.SequenceRuleQuerythe sequence rule query
ErrorsNULL_ARGUMENT sequenceRuleQueryInspector is null
UNSUPPORTED sequenceRuleQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.