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

This session defines methods for finding learning paths through an objective hierarchy based on proficiencies.

This lookup session defines several views:

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete result set or is an error condition
  • isolated objective bank view: All methods in this session operate, retrieve and pertain to objectives defined explicitly in the current objective bank.
  • federated objective bank view: All methods in this session operate, retrieve and pertain to all obtecives defined in this objective bank and any other objectives implicitly available in this objective bank through objective bank inheritence.

The methods useFederatedObjectiveBankView() and useIsolatedObjectiveBankView() behave as a radio group and one should be selected before invoking any lookup methods.

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 obective bank
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanLookupLearningPaths
Description

Tests if this user can perform learning path 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 lookup methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeProficiencyView
Description

The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryProficiencyView
Description

A complete view of the Proficiency returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

CompliancemandatoryThis method is must be implemented.
MethoduseFederatedObjectiveBankView
Description

Federates the view for methods in this session. A federated view will include proficiencies in objective banks which are children of this objective bank in the obective bank hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedObjectiveBankView
Description

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

CompliancemandatoryThis method is must be implemented.
MethodfindPath
Description

Gets the shortest path to an objective. The path is a list of objectives for which there is a deficient proficiency.

Parametersosid.id.IdobjectiveIdthe Id of the Objective to reach
Returnosid.learning.ObjectiveListthe returned list of objectives
ErrorsNOT_FOUND objectiveId not found
NULL_ARGUMENT proficiencyId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodfindPathAtProficiency
Description

Gets the shortest path to an objective. The path is a list of objectives for which there is a proficiency less than the given proficiency.

Parametersosid.id.IdobjectiveIdthe Id of the Objective to reach
osid.id.IdgradeIdthe Id of a proficiency level
Returnosid.learning.ObjectiveListthe returned list of objectives
ErrorsNOT_FOUND objectiveId not found
NULL_ARGUMENT proficiencyId or gradeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetObjectivesByCompletion
Description

Gets the list of objectives for there is a minimum completion.

Parametersosid.id.IdobjectiveIdthe Id of the Objective to reach
cardinalcompletionthe minimum completion as a percentage number
Returnosid.learning.ObjectiveListthe returned list of objectives
ErrorsNOT_FOUND objectiveId not found
NULL_ARGUMENT proficiencyId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.