OSID - osid.course.chronicle.CourseEntryNotificationSession Service Interface Definition

Interface	osid.course.chronicle.CourseEntryNotificationSession
Implements	`osid.OsidSession`
Used By	`osid.course.chronicle.CourseChronicleManager`
Used By	`osid.course.chronicle.CourseChronicleProxyManager`
Description	This session defines methods to receive notifications on adds/changes to `CourseEntry` objects in this `CourseCatalog`. This also includes existing courses that may appear or disappear due to changes in the `CourseCatalog` hierarchy, 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. The two views defined in this session correspond to the views in the `CourseEntryLookupSession`.
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	canRegisterForCourseEntryNotifications
Description	Tests if this user can register for `CourseEntry` 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 course entries in catalogs which are children of this 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 notifications to this course catalog only.
Compliance	`mandatory`		This method is must be implemented.
Method	reliableCourseEntryNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeCourseEntryNotification()`.
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableCourseEntryNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeCourseEntryNotification
Description	Acknowledge a course entry 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	registerForNewCourseEntries
Description	Register for notifications of new course entries. `CourseEntryReceiver.newCourseEntries()` is invoked when a new `CourseEntry` appears in this course catalog.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewCourseEntriesForStudent
Description	Registers for notification of new course entries for the given student. `CourseEntryReceiver.newCourseEntries()` is invoked when a new course entry appears in this course catalog.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the `Resource` to monitor
Errors	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewCourseEntriesForCourse
Description	Registers for notification of new course entries for the given course. `CourseEntryReceiver.newCourseEntries()` is invoked when a course entry appears in this course catalog.
Parameters	`osid.id.Id`	`courseId`	the `Id` of the `Course` to monitor
Errors	NULL_ARGUMENT		`courseId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedCourseEntries
Description	Registers for notification of updated course entries. `CourseEntryReceiver.changedCourseEntries()` is invoked when a course entry in this course catalog is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedCourseEntriesForStudent
Description	Registers for notification of updated course entries for the given student. `CourseEntryReceiver.changedCourseEntries()` is invoked when a course entry in this course catalog is changed.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the `Resource` to monitor
Errors	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedCourseEntriesForCourse
Description	Registers for notification of updated course entries for the given course. `CourseEntryReceiver.changedCourseEntries()` is invoked when a course entry in this course catalog is changed.
Parameters	`osid.id.Id`	`courseId`	the `Id` of the `Course` to monitor
Errors	NULL_ARGUMENT		`courseId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedCourseEntry
Description	Registers for notification of an updated course entry. `CourseEntryReceiver.changedCourseEntries()` is invoked when the specified course entry in this course catalog is changed.
Parameters	`osid.id.Id`	`courseEntryId`	the `Id` of the `CourseEntry` to monitor
Errors	NULL_ARGUMENT		`courseEntryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedCourseEntries
Description	Registers for notification of deleted course entries. `CourseEntryReceiver.deletedCourseEntries()` is invoked when a course entry is deleted or removed from this course catalog.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedCourseEntriesForStudent
Description	Registers for notification of deleted course entries for the given student. `CourseEntryReceiver.deletedCourseEntries()` is invoked when a course entry in this course catalog is removed or deleted.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the `Resource` to monitor
Errors	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedCourseEntriesForCourse
Description	Registers for notification of deleted course entries for the given course. `CourseEntryReceiver.deletedCourseEntries()` is invoked when a course entry in this course catalog is removed or deleted.
Parameters	`osid.id.Id`	`courseId`	the `Id` of the `Course` to monitor
Errors	NULL_ARGUMENT		`courseId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedCourseEntry
Description	Registers for notification of a deleted course entry. `CourseEntryReceiver.deletedCourseEntries()` is invoked when the specified course entry is deleted or removed from this course catalog.
Parameters	`osid.id.Id`	`courseEntryId`	the `Id` of the `CourseEntry` to monitor
Errors	NULL_ARGUMENT		`courseEntryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.