OSID - osid.course.plan.LessonLookupSession Service Interface Definition

Interface	osid.course.plan.LessonLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods for retrieving `Lesson` objects. The `Lesson` represents a collection of syllabi. This session defines views that offer differing behaviors when retrieving multiple objects. comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete view or is an error condition isolated course catalog view: All lesson methods in this session operate, retrieve and pertain to lessonsdefined explicitly in the current course catalog. Using an isolated view is useful for managing lessonswith the `LessonAdminSession.` federated course catalog view: All lesson lookup methods in this session operate, retrieve and pertain to all lessonsdefined in this course catalog and any other course catalogs implicitly available in this course catalog through course catalog inheritence. effective lesson view: All lesson lookup methods return lessons where the current date falls in between the effective dates inclusive. any lesson view: Lessons of any effective date are returned from methods.
Method	getCourseCatalogId
Description	Gets the `CourseCatalog` `Id` associated with this session.
Return	`osid.id.Id`		the `CourseCatalog Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getCourseCatalog
Description	Gets the `CourseCatalog` associated with this session.
Return	`osid.course.CourseCatalog`		the course catalog
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canLookupLessons
Description	Tests if this user can perform `Lesson` 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	useComparativeLessonView
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	usePlenaryLessonView
Description	A complete view of the `Lesson` 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	useFederatedCourseCatalogView
Description	Federates the view for methods in this session. A federated view will include lessonsin course catalogs which are children of this course catalog in the course catalog hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedCourseCatalogView
Description	Isolates the view for methods in this session. An isolated view restricts retrievals to this course catalog only.
Compliance	`mandatory`		This method is must be implemented.
Method	useEffectiveLessonView
Description	Only lessons whose effective dates are current are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyEffectiveLessonView
Description	All lessons of any effective dates are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	getLesson
Description	Gets the `Lesson` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `Lesson` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `Lesson` and retained for compatibility. In effective mode, lessons are returned that are currently effective. In any effective mode, effective lessons and those currently expired are returned.
Parameters	`osid.id.Id`	`lessonId`	`Id` of the `Lesson`
Return	`osid.course.plan.Lesson`		the lesson
Errors	NOT_FOUND		`lessonId` not found
	NULL_ARGUMENT		`lessonId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getLessonsByIds
Description	Gets a `LessonList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the lessonsspecified in the `Id` list, in the order of the list, including duplicates, or an error results if an `Id` in the supplied list is not found or inaccessible. Otherwise, inaccessible `Lessons` may be omitted from the list and may present the elements in any order including returning a unique set. In effective mode, lessons are returned that are currently effective. In any effective mode, effective lessons and those currently expired are returned.
Parameters	`osid.id.IdList`	`lessonIds`	the list of `Ids` to retrieve
Return	`osid.course.plan.LessonList`		the returned `Lesson` list
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`lessonIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getLessonsByGenusType
Description	Gets a `LessonList` corresponding to the given lesson genus `Type` which does not include lessonsof genus types derived from the specified `Type.` In plenary mode, the returned list contains all known lessonsor an error results. Otherwise, the returned list may contain only those lessonsthat are accessible through this session. In effective mode, lessons are returned that are currently effective. In any effective mode, effective lessons and those currently expired are returned.
Parameters	`osid.type.Type`	`lessonGenusType`	a lesson genus type
Return	`osid.course.plan.LessonList`		the returned `Lesson` list
Errors	NULL_ARGUMENT		`lessonGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getLessonsByParentGenusType
Description	Gets a `LessonList` corresponding to the given lesson genus `Type` and include any additional lessonswith genus types derived from the specified `Type.` In plenary mode, the returned list contains all known lessonsor an error results. Otherwise, the returned list may contain only those lessonsthat are accessible through this session. In effective mode, lessons are returned that are currently effective. In any effective mode, effective lessons and those currently expired are returned.
Parameters	`osid.type.Type`	`lessonGenusType`	a lesson genus type
Return	`osid.course.plan.LessonList`		the returned `Lesson` list
Errors	NULL_ARGUMENT		`lessonGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getLessonsByRecordType
Description	Gets a `LessonList` containing the given lesson record `Type.` In plenary mode, the returned list contains all known lessonsor an error results. Otherwise, the returned list may contain only those lessonsthat are accessible through this session. In effective mode, lessons are returned that are currently effective. In any effective mode, effective lessons and those currently expired are returned.
Parameters	`osid.type.Type`	`lessonRecordType`	a lesson record type
Return	`osid.course.plan.LessonList`		the returned `Lesson` list
Errors	NULL_ARGUMENT		`lessonRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getLessonsOnDate
Description	Gets a `LessonList` effective sduring the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known lessonsor an error results. Otherwise, the returned list may contain only those lessonsthat are accessible through this session. In effective mode, lessons are returned that are currently effective. In any effective mode, effective lessons and those currently expired are returned.
Parameters	`osid.calendaring.DateTime`	`from`	s atsrting date
Parameters	`osid.calendaring.DateTime`	`to`	an ending date
Return	`osid.course.plan.LessonList`		the returned `Lesson` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getLessonsForPlan
Description	Gets a `LessonList` for the given plan `Id.` In plenary mode, the returned list contains all known lessons or an error results. Otherwise, the returned list may contain only those lessonsthat are accessible through this session. In effective mode, lessons are returned that are currently effective. In any effective mode, effective lessons and those currently expired are returned.
Parameters	`osid.id.Id`	`planId`	a plan `Id`
Return	`osid.course.plan.LessonList`		the returned `Lesson` list
Errors	NULL_ARGUMENT		`planId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getLessonsForPlanOnDate
Description	Gets a `LessonList` for a plan effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known lessonsor an error results. Otherwise, the returned list may contain only those lessonsthat are accessible through this session. In effective mode, lessons are returned that are currently effective. In any effective mode, effective lessons and those currently expired are returned.
Parameters	`osid.id.Id`	`planId`	a plan `Id`
	`osid.calendaring.DateTime`	`from`	s atsrting date
	`osid.calendaring.DateTime`	`to`	an ending date
Return	`osid.course.plan.LessonList`		the returned `Lesson` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`planId, from,` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getLessonsForDocet
Description	Gets a `LessonList` for the given docet `Id.` In plenary mode, the returned list contains all known lessonsor an error results. Otherwise, the returned list may contain only those lessonsthat are accessible through this session. In effective mode, lessons are returned that are currently effective. In any effective mode, effective lessons and those currently expired are returned.
Parameters	`osid.id.Id`	`docetId`	a docet `Id`
Return	`osid.course.plan.LessonList`		the returned `Lesson` list
Errors	NULL_ARGUMENT		`docetId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getLessonsForDocetOnDate
Description	Gets a `LessonList` for a docet effective sduring the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known lessonsor an error results. Otherwise, the returned list may contain only those lessonsthat are accessible through this session. In effective mode, lessons are returned that are currently effective. In any effective mode, effective lessons and those currently expired are returned.
Parameters	`osid.id.Id`	`docetId`	a docet `Id`
	`osid.calendaring.DateTime`	`from`	s atsrting date
	`osid.calendaring.DateTime`	`to`	an ending date
Return	`osid.course.plan.LessonList`		the returned `Lesson` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`docetId, from,` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getLessonsForPlanAndDocet
Description	Gets a `LessonList` for the given plan and docet. In plenary mode, the returned list contains all known lessonsor an error results. Otherwise, the returned list may contain only those lessonsthat are accessible through this session. In effective mode, lessons are returned that are currently effective. In any effective mode, effective lessons and those currently expired are returned.
Parameters	`osid.id.Id`	`planId`	a plan `Id`
Parameters	`osid.id.Id`	`docetId`	a docet `Id`
Return	`osid.course.plan.LessonList`		the returned `Lesson` list
Errors	NULL_ARGUMENT		`planId` or `docetId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getLessonsForPlanAndDocetOnDate
Description	Gets a `LessonList` for a plan and docet effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known lessonsor an error results. Otherwise, the returned list may contain only those lessonsthat are accessible through this session. In effective mode, lessons are returned that are currently effective. In any effective mode, effective lessons and those currently expired are returned.
Parameters	`osid.id.Id`	`planId`	a plan `Id`
	`osid.id.Id`	`docetId`	a docet `Id`
	`osid.calendaring.DateTime`	`from`	s atsrting date
	`osid.calendaring.DateTime`	`to`	an ending date
Return	`osid.course.plan.LessonList`		the returned `Lesson` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`planId, docetId, from,` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getLessons
Description	Gets all `Lessons.` In plenary mode, the returned list contains all known lessonsor an error results. Otherwise, the returned list may contain only those lessonsthat are accessible through this session. In effective mode, lessons are returned that are currently effective. In any effective mode, effective lessons and those currently expired are returned.
Return	`osid.course.plan.LessonList`		a list of `Lessons`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.