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

Interface	osid.course.plan.LessonConflictSession
Implements	`osid.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.`
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	canAnchorLessons
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.
Return	`boolean`		`false` if plan anchoring methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useFederatedCourseCatalogView
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.
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	getLessonsForPlan
Description	Gets all lessons for a plan.
Parameters	`osid.id.Id`	`planId`	a plan `Id`
Return	`osid.course.plan.LessonList`		a list of lessons
Errors	NOT_FOUND		`planId` is not found
	NULL_ARGUMENT		`planId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getOverlappingLessonIds
Description	Gets a list of overlapping lessons.
Parameters	`osid.id.Id`	`planId`	a plan `Id`
Return	`osid.id.IdList`		a list of lesson `Ids`
Errors	NOT_FOUND		`planId` is not found
	NULL_ARGUMENT		`planId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getOverlappingLessons
Description	Gets a list of overlapping lessons.
Parameters	`osid.id.Id`	`planId`	a plan `Id`
Return	`osid.course.plan.LessonList`		a list of lessons
Errors	NOT_FOUND		`planId` is not found
	NULL_ARGUMENT		`planId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getStartingOffsetLessonIds
Description	Gets a list of lesson `Ids` that do not begin at the start of an activity.
Parameters	`osid.id.Id`	`planId`	a plan `Id`
Return	`osid.id.IdList`		a list of lesson `Ids`
Errors	NOT_FOUND		`planId` is not found
	NULL_ARGUMENT		`planId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getStartingOffsetLessons
Description	Gets a list of lessons that do not begin at the start of an activity.
Parameters	`osid.id.Id`	`planId`	a plan `Id`
Return	`osid.course.plan.LessonList`		a list of lessons
Errors	NOT_FOUND		`planId` is not found
	NULL_ARGUMENT		`planId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getEndingOffsetLessonIds
Description	Gets a list of lesson `Ids` that do not end at the end of an activity.
Parameters	`osid.id.Id`	`planId`	a plan `Id`
Return	`osid.id.IdList`		a list of lesson `Ids`
Errors	NOT_FOUND		`planId` is not found
	NULL_ARGUMENT		`planId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getEndingOffsetLessons
Description	Gets a list of lessons that do not end at the end of an activity.
Parameters	`osid.id.Id`	`planId`	a plan `Id`
Return	`osid.course.plan.LessonList`		a list of lessons
Errors	NOT_FOUND		`planId` is not found
	NULL_ARGUMENT		`planId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getActivityIdsWithLessonGaps
Description	Gets a list of activity `Ids` with lesson gaps or missing lessons.
Parameters	`osid.id.Id`	`planId`	a plan `Id`
Return	`osid.id.IdList`		a list of activity `Ids`
Errors	NOT_FOUND		`planId` is not found
	NULL_ARGUMENT		`planId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getActivitiesWithLessonGaps
Description	Gets a list of activities with lesson gaps.
Parameters	`osid.id.Id`	`planId`	a plan `Id`
Return	`osid.course.ActivityList`		a list of activities
Errors	NOT_FOUND		`planId` is not found
	NULL_ARGUMENT		`planId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.