OSID Logo
OSID Specifications
assessment authoring package
Version 3.0.0
Release Candidate Preview
Interfaceosid.assessment.authoring.SequenceRuleEnablerSmartBankSession
Implementsosid.OsidSession
Description

This session manages queries and sequencing to create "smart" dynamic bank. a SequenceRuleEnablerQuery can be retrieved from this session and mapped to this Bank to create a virtual collection of sequence rule enablers. The sequence rule enablers may be sequenced using the SequenceRuleEnablerSearchOrder from this session.

This Bank has a default query that matches any sequence rule enabler and a default search order that specifies no sequencing. The queries may be examined using a SequenceRuleEnablerQueryInspector. The query may be modified by converting the inspector back to a SequenceRuleEnablerQuery.

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.
MethodgetSequenceRuleEnablerQuery
Description

Gets a sequence rule enabler query.

Returnosid.assessment.authoring.SequenceRuleEnablerQuerythe sequence rule enabler query
CompliancemandatoryThis method must be implemented.
MethodgetSequenceRuleEnablerSearchOrder
Description

Gets a sequence rule enabler search order.

Returnosid.assessment.authoring.SequenceRuleEnablerSearchOrderthe sequence rule enabler search order
CompliancemandatoryThis method must be implemented.
MethodapplySequenceRuleEnablerQuery
Description

Applies a sequence rule enabler query to this bank.

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

Gets a sequence rule enabler query inspector for this bank.

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

Applies a sequence rule enabler search order to this bank.

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

Gets a sequence rule enabler query from an inspector.

Parametersosid.assessment.authoring.SequenceRuleEnablerQueryInspectorsequenceRuleEnablerQueryInspectora sequence rule enabler query inspector
Returnosid.assessment.authoring.SequenceRuleEnablerQuerythe sequence rule enabler query
ErrorsNULL_ARGUMENT sequenceRuleEnablerQueryInspector is null
UNSUPPORTED sequenceRuleEnablerQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.