OSID - osid.learning.LearningPathSession Service Interface Definition

Interface	osid.learning.LearningPathSession
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: 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.
Method	getObjectiveBankId
Description	Gets the `ObjectiveBank` `Id` associated with this session.
Return	`osid.id.Id`		the `ObjectiveBank Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getObjectiveBank
Description	Gets the `ObjectiveBank` associated with this session.
Return	`osid.learning.ObjectiveBank`		the obective bank
Errors	OPERATION_FAILED		unable to complete request
Errors	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 `PERMISSION_DENIED.` This is intended as a hint to an application that may not offer lookup operations to unauthorized users.
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 `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.
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	findPathForResource
Description	Gets the shortest path to an objective. The path is a list of objectives for which the resource has a deficient proficiency.
Parameters	`osid.id.Id`	`objectiveId`	the `Id` of the `Objective` to reach
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the `Resource`
Return	`osid.learning.ObjectiveList`		the returned list of objectives
Errors	NOT_FOUND		`objectiveId` or `resourceId` not found
	NULL_ARGUMENT		`proficiencyId` or `resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	findPathForResourceAtProficiency
Description	Gets the shortest path to an objective. The path is a list of objectives for which the resource has a proficiency less than the given proficiency.
Parameters	`osid.id.Id`	`objectiveId`	the `Id` of the `Objective` to reach
	`osid.id.Id`	`resourceId`	the `Id` of the `Resource`
	`osid.id.Id`	`gradeId`	the `Id` of a proficiency level
Return	`osid.learning.ObjectiveList`		the returned list of objectives
Errors	NOT_FOUND		`objectiveId` or `resourceId` not found
	NULL_ARGUMENT		`proficiencyId, resourceId` or `gradeId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getObjectivesForResourceByCompletion
Description	Gets the list of objectives for a resource that have a minimum completion.
Parameters	`osid.id.Id`	`objectiveId`	the `Id` of the `Objective` to reach
	`osid.id.Id`	`resourceId`	the `Id` of the `Resource`
	`cardinal`	`completion`	the minimum completion as a percentage number
Return	`osid.learning.ObjectiveList`		the returned list of objectives
Errors	NOT_FOUND		`objectiveId` or `resourceId` not found
	NULL_ARGUMENT		`proficiencyId` or `resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.