OSID Logo
OSID Specifications
assessment authoring package
Version 3.0.0
Release Candidate Preview
Interfaceosid.assessment.authoring.SequenceRuleEnablerQuery
Implementsosid.OsidEnablerQuery
Description

This is the query for searching sequence rule enablers. Each method match specifies a AND term while multiple invocations of the same method produce a nested OR.

MethodmatchRuledSequenceRuleId
Description

Matches enablers mapped to the sequence rule.

Parametersosid.id.IdsequenceRuleIdthe sequence rule Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT sequenceRuleId is null
CompliancemandatoryThis method must be implemented.
MethodclearRuledSequenceRuleIdTerms
Description

Clears the sequence rule Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsRuledSequenceRuleQuery
Description

Tests if a SequenceRuleQuery is available.

Returnboolean true if a sequence rule query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetRuledSequenceRuleQuery
Description

Gets the query for a sequence rule. Multiple retrievals produce a nested OR term.

Returnosid.assessment.authoring.SequenceRuleQuerythe sequence rule query
ErrorsUNIMPLEMENTED supportsRuledSequenceRuleQuery() is false
ComplianceoptionalThis method must be implemented if supportsRuledSequenceRuleQuery() is true.
MethodmatchAnyRuledSequenceRule
Description

Matches enablers mapped to any sequence rule.

Parametersbooleanmatch true for enablers mapped to any sequence rule, false to match enablers mapped to no sequence rules
CompliancemandatoryThis method must be implemented.
MethodclearRuledSequenceRuleTerms
Description

Clears the sequence rule query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchBankId
Description

Matches enablers mapped to the bank.

Parametersosid.id.IdbankIdthe bank Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT bankId is null
CompliancemandatoryThis method must be implemented.
MethodclearBankIdTerms
Description

Clears the bank Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsBankQuery
Description

Tests if an BankQuery is available.

Returnboolean true if a bank query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetBankQuery
Description

Gets the query for a bank. Multiple retrievals produce a nested OR term.

Returnosid.assessment.BankQuerythe bank query
ErrorsUNIMPLEMENTED supportsBankQuery() is false
ComplianceoptionalThis method must be implemented if supportsBankQuery() is true.
MethodclearBankTerms
Description

Clears the bank query terms.

CompliancemandatoryThis method must be implemented.
MethodgetSequenceRuleEnablerQueryRecord
Description

Gets the sequence rule enabler query record corresponding to the given SequenceRuleEnabler record Type. Multiple record retrievals produce a nested OR term.

Parametersosid.type.TypesequenceRuleEnablerRecordTypea sequence rule enabler record type
Returnosid.assessment.authoring.records.SequenceRuleEnablerQueryRecordthe sequence rule enabler query record
ErrorsNULL_ARGUMENT sequenceRuleEnablerRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(sequenceRuleEnablerRecordType) is false
CompliancemandatoryThis method must be implemented.