OSID Logo
OSID Specifications
course chronicle package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.chronicle.CourseEntryNotificationSession
Implementsosid.OsidSession
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.

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.
MethodcanRegisterForCourseEntryNotifications
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.

Returnboolean false if notification 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 course entries in catalogs which are children of this 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 notifications to this course catalog only.

CompliancemandatoryThis method is must be implemented.
MethodreliableCourseEntryNotifications
Description

Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using acknowledgeCourseEntryNotification() .

CompliancemandatoryThis method is must be implemented.
MethodunreliableCourseEntryNotifications
Description

Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.

CompliancemandatoryThis method is must be implemented.
MethodacknowledgeCourseEntryNotification
Description

Acknowledge a course entry notification.

Parametersosid.id.IdnotificationIdthe Id of the notification
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewCourseEntries
Description

Register for notifications of new course entries. CourseEntryReceiver.newCourseEntries() is invoked when a new CourseEntry appears in this course catalog.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewCourseEntriesForStudent
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.

Parametersosid.id.IdresourceIdthe Id of the Resource to monitor
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewCourseEntriesForCourse
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.

Parametersosid.id.IdcourseIdthe Id of the Course to monitor
ErrorsNULL_ARGUMENT courseId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedCourseEntries
Description

Registers for notification of updated course entries. CourseEntryReceiver.changedCourseEntries() is invoked when a course entry in this course catalog is changed.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedCourseEntriesForStudent
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.

Parametersosid.id.IdresourceIdthe Id of the Resource to monitor
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedCourseEntriesForCourse
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.

Parametersosid.id.IdcourseIdthe Id of the Course to monitor
ErrorsNULL_ARGUMENT courseId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedCourseEntry
Description

Registers for notification of an updated course entry. CourseEntryReceiver.changedCourseEntries() is invoked when the specified course entry in this course catalog is changed.

Parametersosid.id.IdcourseEntryIdthe Id of the CourseEntry to monitor
ErrorsNULL_ARGUMENT courseEntryId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedCourseEntries
Description

Registers for notification of deleted course entries. CourseEntryReceiver.deletedCourseEntries() is invoked when a course entry is deleted or removed from this course catalog.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedCourseEntriesForStudent
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.

Parametersosid.id.IdresourceIdthe Id of the Resource to monitor
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedCourseEntriesForCourse
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.

Parametersosid.id.IdcourseIdthe Id of the Course to monitor
ErrorsNULL_ARGUMENT courseId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedCourseEntry
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.

Parametersosid.id.IdcourseEntryIdthe Id of the CourseEntry to monitor
ErrorsNULL_ARGUMENT courseEntryId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.