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

Interface	osid.course.plan.LessonNotificationSession
Implements	`osid.OsidSession`
Description	This session defines methods to receive notifications on adds/changes to `Lesson` objects. This session is intended for consumers needing to synchronize their state with this service without the use of polling. Notifications are cancelled when this session is closed. Notifications are triggered with changes to the `Lesson` object itself. Adding and removing syllabi result in notifications available from the notification session for syllabi.
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	canRegisterForLessonNotifications
Description	Tests if this user can register for `Lesson` notifications. 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 notification operations.
Return	`boolean`		`false` if notification 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 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	reliableLessonNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeLessonNotification()` .
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableLessonNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeLessonNotification
Description	Acknowledge a lesson notification.
Parameters	`osid.id.Id`	`notificationId`	the `Id` of the notification
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewLessons
Description	Register for notifications of new lessons. `LessonReceiver.newLessons()` is invoked when a new `Lesson` is created.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewLessonsForPlan
Description	Registers for notification of new lessons of the given plan. `LessonReceiver.newLessons()` is invoked when a new `Lesson` is created.
Parameters	`osid.id.Id`	`planId`	the `Id` of the `Plan` to monitor
Errors	NULL_ARGUMENT		`planId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewLessonsForDocet
Description	Registers for notification of new lessons of the given docet. `LessonReceiver.newLessons()` is invoked when a new `Lesson` is created.
Parameters	`osid.id.Id`	`docetId`	the `Id` of the `Docet` to monitor
Errors	NULL_ARGUMENT		`docetId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedLessons
Description	Registers for notification of updated lessons. `LessonReceiver.changedLessons()` is invoked when a lesson is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedLessonsForPlan
Description	Registers for notification of updated lessons of the given plan. `LessonReceiver.changedLessons()` is invoked when a a lesson is changed.
Parameters	`osid.id.Id`	`planId`	the `Id` of the `Plan` to monitor
Errors	NULL_ARGUMENT		`planId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedLessonsForDocet
Description	Registers for notification of updated lessons of the given docet. `LessonReceiver.changedLessons()` is invoked when a a lesson is changed.
Parameters	`osid.id.Id`	`docetId`	the `Id` of the `Docet` to monitor
Errors	NULL_ARGUMENT		`docetId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedLesson
Description	Registers for notification of an updated lesson. `LessonReceiver.changedLessons()` is invoked when the specified lesson in this course catalog is changed.
Parameters	`osid.id.Id`	`lessonId`	the `Id` of the `Lesson` to monitor
Errors	NULL_ARGUMENT		`lessonId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedLessons
Description	Registers for notification of deleted lessons. `LessonReceiver.deletedLesson()` is invoked when a lesson is in this course catalog deleted.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedLessonsForPlan
Description	Registers for notification of deleted lessons of the given plan. `LessonReceiver.deletedLessons()` is invoked when a lesson in this course catalog is removed.
Parameters	`osid.id.Id`	`planId`	the `Id` of the `Plan` to monitor
Errors	NULL_ARGUMENT		`planId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedLessonsForDocet
Description	Registers for notification of deleted lessons of the given docet. `LessonReceiver.deletedLessons()` is invoked when a lesson in this course catalog is removed.
Parameters	`osid.id.Id`	`docetId`	the `Id` of the `Docet` to monitor
Errors	NULL_ARGUMENT		`docetId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedLesson
Description	Registers for notification of a deleted lesson. `LessonReceiver.deletedLessons()` is invoked when the specified lesson is deleted.
Parameters	`osid.id.Id`	`lessonId`	the `Id` of the `Lesson` to monitor
Errors	NULL_ARGUMENT		`lessonId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.