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

This session manages queries and sequencing to create "smart" dynamic catalogs. An ObjectiveQuery can be retrieved from this session and mapped to this ObjectiveBank to create a virtual collection of Objectives. The objectives may be sequenced using the ObjectiveSearchOrder from this session.

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

MethodgetObjectiveBankId
Description

Gets the ObjectiveBank 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 ObjectiveBank associated with this session
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 assessment. 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 objective bank management is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetObjectiveQuery
Description

Gets an objective query.

Returnosid.learning.ObjectiveQuerythe objective query
CompliancemandatoryThis method must be implemented.
MethodgetObjectiveSearchOrder
Description

Gets an objective search order.

Returnosid.learning.ObjectiveSearchOrderthe objective search order
CompliancemandatoryThis method must be implemented.
MethodapplyObjectiveQuery
Description

Applies an objective query to this bank.

Parametersosid.learning.ObjectiveQueryobjectiveQuerythe objective query
ErrorsNULL_ARGUMENT objectiveQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED objectiveQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectObjectiveQuery
Description

Gets an objective query inspector for this objective bank.

Returnosid.learning.ObjectiveQueryInspectorthe objective query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyObjectiveSequencing
Description

Applies an objective search order to this objective bank.

Parametersosid.learning.ObjectiveSearchOrderobjectiveSearchOrderthe objective search order
ErrorsNULL_ARGUMENT objectiveSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED objectiveSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetObjectiveQueryFromInspector
Description

Gets an objective query from an inspector.

Parametersosid.learning.ObjectiveQueryInspectorobjectiveQueryInspectora query inspector
Returnosid.learning.ObjectiveQuerythe objective query
ErrorsNULL_ARGUMENT objectiveQueryInspector is null
UNSUPPORTED objectiveQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.