Interface | osid.learning.MyLearningPathSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods for finding learning paths through an objective hierarchy based on proficiencies. This lookup session defines several views:
The methods | ||
Method | getObjectiveBankId | ||
Description |
Gets the | ||
Return | osid.id.Id | the ObjectiveBank Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getObjectiveBank | ||
Description |
Gets the | ||
Return | osid.learning.ObjectiveBank | the obective bank | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canLookupLearningPaths | ||
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 | ||
Return | boolean | false if lookup methods are not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativeProficiencyView | ||
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. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | usePlenaryProficiencyView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useFederatedObjectiveBankView | ||
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. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedObjectiveBankView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts retrievals to this objective bank only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | findPath | ||
Description |
Gets the shortest path to an objective. The path is a list of objectives for which there is a deficient proficiency. | ||
Parameters | osid.id.Id | objectiveId | the Id of the Objective to reach |
Return | osid.learning.ObjectiveList | the returned list of objectives | |
Errors | NOT_FOUND | objectiveId not found | |
NULL_ARGUMENT | proficiencyId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | findPathAtProficiency | ||
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. | ||
Parameters | osid.id.Id | objectiveId | the Id of the Objective to reach |
osid.id.Id | gradeId | the Id of a proficiency level | |
Return | osid.learning.ObjectiveList | the returned list of objectives | |
Errors | NOT_FOUND | objectiveId not found | |
NULL_ARGUMENT | proficiencyId or gradeId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getObjectivesByCompletion | ||
Description |
Gets the list of objectives for there is a minimum completion. | ||
Parameters | osid.id.Id | objectiveId | the Id of the Objective to reach |
cardinal | completion | the minimum completion as a percentage number | |
Return | osid.learning.ObjectiveList | the returned list of objectives | |
Errors | NOT_FOUND | objectiveId not found | |
NULL_ARGUMENT | proficiencyId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |