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

This session provides methods for searching among SequenceRuleEnabler objects. The search query is constructed using the SequenceRuleEnablerQuery.

This session defines views that offer differing behaviors for searching.

  • federated bank view: searches include sequence rule enablers in bank of which this bank is an ancestor in the bank hierarchy
  • isolated bank view: searches are restricted to sequence rule enablers in this bank

sequence rule enablers may have a query record indicated by their respective record types. The query record is accessed via the 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.
MethodcanSearchSequenceRuleEnablers
Description

Tests if this user can perform SequenceRuleEnabler 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 enablers 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.
MethodgetSequenceRuleEnablerQuery
Description

Gets a sequence rule enabler query.

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

Gets a list of SequenceRuleEnablers matching the given sequence rule enabler query.

Parametersosid.assessment.authoring.SequenceRuleEnablerQuerysequenceRuleEnablerQuerythe sesequence rule enabler query
Returnosid.assessment.authoring.SequenceRuleEnablerListthe returned SequenceRuleEnablerList
ErrorsNULL_ARGUMENT sequenceRuleEnablerQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED sequenceRuleEnablerQuery is not of this service
CompliancemandatoryThis method must be implemented.