public interface LearningPathSession extends OsidSession
This session defines methods for finding learning paths through an objective hierarchy based on proficiencies.
This lookup session defines several views:
The methods useFederatedObjectiveBankView()
and
useIsolatedObjectiveBankView()
behave as a radio group and one
should be selected before invoking any lookup methods.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupLearningPaths()
Tests if this user can perform learning path lookups.
|
ObjectiveList |
findPathForResource(Id objectiveId,
Id resourceId)
Gets the shortest path to an objective.
|
ObjectiveList |
findPathForResourceAtProficiency(Id objectiveId,
Id resourceId,
Id gradeId)
Gets the shortest path to an objective.
|
ObjectiveBank |
getObjectiveBank()
Gets the
ObjectiveBank associated with this session. |
Id |
getObjectiveBankId()
Gets the
ObjectiveBank Id associated
with this session. |
ObjectiveList |
getObjectivesForResourceByCompletion(Id objectiveId,
Id resourceId,
long completion)
Gets the list of objectives for a resource that have a minimum
completion.
|
void |
useComparativeProficiencyView()
The returns from the lookup methods may omit or translate elements
based on this session, such as authorization, and not result in an
error.
|
void |
useFederatedObjectiveBankView()
Federates the view for methods in this session.
|
void |
useIsolatedObjectiveBankView()
Isolates the view for methods in this session.
|
void |
usePlenaryProficiencyView()
A complete view of the
Proficiency returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getObjectiveBankId()
ObjectiveBank
Id
associated
with this session. ObjectiveBank Id
associated with this
sessionmandatory
- This method must be implemented. ObjectiveBank getObjectiveBank() throws OperationFailedException, PermissionDeniedException
ObjectiveBank
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canLookupLearningPaths()
PERMISSION_DENIED.
This is intended as a hint to an
application that may not offer lookup operations to unauthorized
users. false
if lookup methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeProficiencyView()
mandatory
- This method is must be implemented. void usePlenaryProficiencyView()
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.mandatory
- This method is must be implemented. void useFederatedObjectiveBankView()
mandatory
- This method is must be implemented. void useIsolatedObjectiveBankView()
mandatory
- This method is must be implemented. ObjectiveList findPathForResource(Id objectiveId, Id resourceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
objectiveId
- the Id
of the Objective
to reachresourceId
- the Id
of the Resource
NotFoundException
- objectiveId
or
resourceId
not foundNullArgumentException
- proficiencyId
or
resourceId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ObjectiveList findPathForResourceAtProficiency(Id objectiveId, Id resourceId, Id gradeId) throws NotFoundException, OperationFailedException, PermissionDeniedException
objectiveId
- the Id
of the Objective
to reachresourceId
- the Id
of the Resource
gradeId
- the Id
of a proficiency levelNotFoundException
- objectiveId
or
resourceId
not foundNullArgumentException
- proficiencyId,
resourceId
or gradeId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ObjectiveList getObjectivesForResourceByCompletion(Id objectiveId, Id resourceId, long completion) throws NotFoundException, OperationFailedException, PermissionDeniedException
objectiveId
- the Id
of the Objective
to reachresourceId
- the Id
of the Resource
completion
- the minimum completion as a percentage numberNotFoundException
- objectiveId
or
resourceId
not foundNullArgumentException
- proficiencyId
or
resourceId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.