Interface | osid.course.plan.LessonSmartCourseCatalogSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session manages queries and sequencing to create
"smart" dynamic catalogs. A This | ||
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 CourseCatalog associated with this session | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageSmartCourseCatalogs | ||
Description |
Tests if this user can manage smart course catalogs. A
return of true does not guarantee successful
authorization. A return of false indicates that it is
known methods in this session will result in a | ||
Return | boolean | false if smart course catalog management is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getLessonQuery | ||
Description |
Gets a lesson query. | ||
Return | osid.course.plan.LessonQuery | the lesson query | |
Compliance | mandatory | This method must be implemented. | |
Method | getLessonSearchOrder | ||
Description |
Gets a lesson search order. | ||
Return | osid.course.plan.LessonSearchOrder | the lesson search order | |
Compliance | mandatory | This method must be implemented. | |
Method | applyLessonQuery | ||
Description |
Applies a lesson query to this course catalog. | ||
Parameters | osid.course.plan.LessonQuery | lessonQuery | the lesson query |
Errors | NULL_ARGUMENT | lessonQuery is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | lessonQuery not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | inspectLessonQuery | ||
Description |
Gets a lesson query inspector for this course catalog. | ||
Return | osid.course.plan.LessonQueryInspector | the lesson query inspector | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | applyLessonSequencing | ||
Description |
Applies a lesson search order to this course catalog. | ||
Parameters | osid.course.plan.LessonSearchOrder | lessonSearchOrder | the lesson search order |
Errors | NULL_ARGUMENT | lessonSearchOrder is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | lessonSearchOrder not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getLessonQueryFromInspector | ||
Description |
Gets a lesson query from an inspector. | ||
Parameters | osid.course.plan.LessonQueryInspector | lessonQueryInspector | a query inspector |
Return | osid.course.plan.LessonQuery | the lesson query | |
Errors | NULL_ARGUMENT | lessonQueryInspector is null | |
UNSUPPORTED | lessonQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |