Interface | osid.course.plan.LessonLookupSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods for retrieving This session defines views that offer differing behaviors when retrieving multiple objects.
| ||
Method | getCourseCatalogId | ||
Description |
Gets the | ||
Return | osid.id.Id | the CourseCatalog Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getCourseCatalog | ||
Description |
Gets the | ||
Return | osid.course.CourseCatalog | the course catalog | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canLookupLessons | ||
Description |
Tests if this user can perform | ||
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 | ||
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 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 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 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 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 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 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 |
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 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 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 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 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 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 | |
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 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 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 | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |