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

Interface	osid.course.plan.LessonAnchoringSession
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	getLessonAnchorsForPlan
Description	Gets all lesson anchors for a plan.
Parameters	`osid.id.Id`	`planId`	a plan `Id`
Return	`osid.course.plan.LessonAnchorList`		a list of lesson anchors
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	getLessonAnchorsForLesson
Description	Gets all lesson anchors for a lesson.
Parameters	`osid.id.Id`	`lessonId`	a lesson `Id`
Return	`osid.course.plan.LessonAnchorList`		a list of lesson anchors
Errors	NOT_FOUND		`lessonId` is not found
	NULL_ARGUMENT		`lessonId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	addLessonAnchor
Description	Adds a lesson anchor.
Parameters	`osid.id.Id`	`lessonId`	a lesson `Id`
	`osid.id.Id`	`activityId`	an activity `Id`
	`osid.calendaring.Duration`	`offset`	a time offset
Errors	NOT_FOUND		`lessonId` or `activityId` is not found, or `activityId` is not related to `lessonId`
	NULL_ARGUMENT		`lessonId, activityId,` or `offset` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	clearLessonAnchorsForPlan
Description	Clears all lesson anchors for an entire plan.
Parameters	`osid.id.Id`	`planId`	a plan `Id`
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	clearLessonAnchorsForLesson
Description	Clears all lesson anchors in a lesson.
Parameters	`osid.id.Id`	`lessonId`	a lesson `Id`
Errors	NOT_FOUND		`lessonId` is not found
	NULL_ARGUMENT		`lessonId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	clearLessonAnchorsForLessonByOffset
Description	Clears all lesson anchors within the given offset range inclusive.
Parameters	`osid.id.Id`	`lessonId`	a lesson `Id`
	`osid.calendaring.Duration`	`start`	a starting time offset
	`osid.calendaring.Duration`	`end`	an ending time offset
Errors	INVALID_ARGUMENT		`start` is greater than `end`
	NOT_FOUND		`lessonId` is not found
	NULL_ARGUMENT		`lessonId, start,` or `end` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.