OSID Logo
OSID Specifications
learning package
Version 3.0.0
Release Candidate Preview
Interfaceosid.learning.ProficiencySmartObjectiveBankSession
Implementsosid.OsidSession
Description

This session manages queries and sequencing to create "smart" dynamic catalogs. A ProficiencyQuery can be retrieved from this session and mapped to this ObjectiveBank to create a virtual collection of Proficiencies. The proficiencies may be sequenced using the ProficiencySearchOrder from this session.

This ObjectiveBank has a default query that matches any proficiency and a default search order that specifies no sequencing. The queries may be examined using a ProficiencyQueryInspector. The query may be modified by converting the inspector back to a ProficiencyQuery.

MethodgetObjectiveBankId
Description

Gets the Familt Id associated with this session.

Returnosid.id.Idthe ObjectiveBank Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetObjectiveBank
Description

Gets the ObjectiveBank associated with this session.

Returnosid.learning.ObjectiveBankthe obective bank
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanManageSmartObjectiveBanks
Description

Tests if this user can manage smart objective banks. 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 opt not to offer smart operations.

Returnboolean false if smart objective bank methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetProficiencyQuery
Description

Gets a proficiency query.

Returnosid.learning.ProficiencyQuerythe proficiency query
CompliancemandatoryThis method must be implemented.
MethodgetProficiencySearchOrder
Description

Gets a proficiency search order.

Returnosid.learning.ProficiencySearchOrderthe proficiency search order
CompliancemandatoryThis method must be implemented.
MethodapplyProficiencyQuery
Description

Applies a proficiency query to this objective bank.

Parametersosid.learning.ProficiencyQueryproficiencyQuerythe proficiency query
ErrorsNULL_ARGUMENT proficiencyQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED proficiencyQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectProficiencyQuery
Description

Gets a proficiency query inspector for this objective bank.

Returnosid.learning.ProficiencyQueryInspectorthe proficiency query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyProficiencySequencing
Description

Applies a proficiency search order to this objective bank.

Parametersosid.learning.ProficiencySearchOrderproficiencySearchOrderthe proficiency search order
ErrorsNULL_ARGUMENT proficiencySearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED proficiencySearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetProficiencyQueryFromInspector
Description

Gets a proficiency query from an inspector.

Parametersosid.learning.ProficiencyQueryInspectorproficiencyQueryInspectora proficiency query inspector
Returnosid.learning.ProficiencyQuerythe proficiency query
ErrorsNULL_ARGUMENT relatinshipQueryInspector is null
UNSUPPORTED proficiencyQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.