OSID Logo
OSID Specifications
course plan package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.plan.LessonConflictSession
Implementsosid.OsidSession
Description

This session provides a way of "anchoring" lessons with a plan. Lessons correspond to their corresponding Docents laid out along the related Activities. The LessonAnchor ties a Lesson to a specific Activity or at a specific time offet within the specific Activity.

Automatic generation of Lessons should be constrained around the LessonAnchors.

MethodgetCourseCatalogId
Description

Gets the CourseCatalog Id associated with this session.

Returnosid.id.Idthe CourseCatalog Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetCourseCatalog
Description

Gets the CourseCatalog associated with this session.

Returnosid.course.CourseCatalogthe course catalog
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanAnchorLessons
Description

Tests if this user can anchor lessons. 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 opt not to offer these operations.

Returnboolean false if plan anchoring methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseFederatedCourseCatalogView
Description

Federates the view for methods in this session. A federated view will include plans in course catalogs which are children of this course catalog in the course catalog hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedCourseCatalogView
Description

Isolates the view for methods in this session. An isolated view restricts retrievals to this course catalog only.

CompliancemandatoryThis method is must be implemented.
MethodgetLessonsForPlan
Description

Gets all lessons for a plan.

Parametersosid.id.IdplanIda plan Id
Returnosid.course.plan.LessonLista list of lessons
ErrorsNOT_FOUND planId is not found
NULL_ARGUMENT planId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetOverlappingLessonIds
Description

Gets a list of overlapping lessons.

Parametersosid.id.IdplanIda plan Id
Returnosid.id.IdLista list of lesson Ids
ErrorsNOT_FOUND planId is not found
NULL_ARGUMENT planId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetOverlappingLessons
Description

Gets a list of overlapping lessons.

Parametersosid.id.IdplanIda plan Id
Returnosid.course.plan.LessonLista list of lessons
ErrorsNOT_FOUND planId is not found
NULL_ARGUMENT planId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetStartingOffsetLessonIds
Description

Gets a list of lesson Ids that do not begin at the start of an activity.

Parametersosid.id.IdplanIda plan Id
Returnosid.id.IdLista list of lesson Ids
ErrorsNOT_FOUND planId is not found
NULL_ARGUMENT planId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetStartingOffsetLessons
Description

Gets a list of lessons that do not begin at the start of an activity.

Parametersosid.id.IdplanIda plan Id
Returnosid.course.plan.LessonLista list of lessons
ErrorsNOT_FOUND planId is not found
NULL_ARGUMENT planId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetEndingOffsetLessonIds
Description

Gets a list of lesson Ids that do not end at the end of an activity.

Parametersosid.id.IdplanIda plan Id
Returnosid.id.IdLista list of lesson Ids
ErrorsNOT_FOUND planId is not found
NULL_ARGUMENT planId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetEndingOffsetLessons
Description

Gets a list of lessons that do not end at the end of an activity.

Parametersosid.id.IdplanIda plan Id
Returnosid.course.plan.LessonLista list of lessons
ErrorsNOT_FOUND planId is not found
NULL_ARGUMENT planId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetActivityIdsWithLessonGaps
Description

Gets a list of activity Ids with lesson gaps or missing lessons.

Parametersosid.id.IdplanIda plan Id
Returnosid.id.IdLista list of activity Ids
ErrorsNOT_FOUND planId is not found
NULL_ARGUMENT planId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetActivitiesWithLessonGaps
Description

Gets a list of activities with lesson gaps.

Parametersosid.id.IdplanIda plan Id
Returnosid.course.ActivityLista list of activities
ErrorsNOT_FOUND planId is not found
NULL_ARGUMENT planId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.