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

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.
MethodcanSearchSequenceRules
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.

Returnboolean false if search methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseFederatedBankView
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.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedBankView
Description

Isolates the view for methods in this session. An isolated view restricts lookups to this bank only.

CompliancemandatoryThis method is must be implemented.
MethodgetSequenceRuleQuery
Description

Gets a sequence rule query.

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

Gets a list of SequenceRules matching the given sequence rule query.

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