OSID Logo
OSID Specifications
course package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.CourseOfferingNotificationSession
Implementsosid.OsidSession
Description

This session defines methods to receive notifications on adds/changes to CourseOffering objects in this CourseCatalog. This also includes existing course offerings 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 CourseOfferingLookupSession.

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.
MethodcanRegisterForCourseOfferingNotifications
Description

Tests if this user can register for CourseOffering 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 offerings 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.
MethodreliableCourseOfferingNotifications
Description

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

CompliancemandatoryThis method is must be implemented.
MethodunreliableCourseOfferingNotifications
Description

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

CompliancemandatoryThis method is must be implemented.
MethodacknowledgeCourseOfferingNotification
Description

Acknowledge a course offering notification.

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

Register for notifications of new course offerings. CourseOfferingReceiver.newCourseOfferings() is invoked when a new CourseOffering appears in this course catalog.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewCourseOfferingsForCourse
Description

Registers for notification of a new course offering for a given course. CourseOfferingReceiver.newCourseOfferings() is invoked when a new course offering 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.
MethodregisterForNewCourseOfferingsForTerm
Description

Registers for notification of a new course offering for a given term. CourseOfferingReceiver.newCourseOfferings() is invoked when a new course offering appears in this course catalog.

Parametersosid.id.IdtermIdthe Id of the Term to monitor
ErrorsNULL_ARGUMENT termId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedCourseOfferings
Description

Registers for notification of updated courses. CourseOfferingReceiver.changedCourseOfferings() is invoked when a course in this course catalog is changed.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedCourseOfferingsForCourse
Description

Registers for notification of a changed course offering for a given course. CourseOfferingReceiver.newCourseOfferings() is invoked when a course offering in this course catalog is updated.

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.
MethodregisterForChangedCourseOfferingsForTerm
Description

Registers for notification of a changed course offering for a given term. CourseOfferingReceiver.newCourseOfferings() is invoked when a course offering in this course catalog is updated.

Parametersosid.id.IdtermIdthe Id of the Term to monitor
ErrorsNULL_ARGUMENT termId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedCourseOffering
Description

Registers for notification of an updated course offering. CourseOfferingReceiver.changedCourseOfferings() is invoked when the specified course offering in this course catalog is changed.

Parametersosid.id.IdcourseOfferingIdthe Id of the CourseOffering to monitor
ErrorsNULL_ARGUMENT courseOfferingId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedCourseOfferings
Description

Registers for notification of deleted courses. CourseOfferingReceiver.deletedCourseOfferings() is invoked when a course offering is deleted or removed from this course catalog.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedCourseOfferingsForCourse
Description

Registers for notification of a deleted course offering for a given course. CourseOfferingReceiver.newCourseOfferings() is invoked when a course offering is removed from 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.
MethodregisterForDeletedCourseOfferingsForTerm
Description

Registers for notification of a deleted course offering for a given term. CourseOfferingReceiver.newCourseOfferings() is invoked when a course offering is removed from this course catalog.

Parametersosid.id.IdtermIdthe Id of the Term to monitor
ErrorsNULL_ARGUMENT termId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedCourseOffering
Description

Registers for notification of a deleted course offering. CourseOfferingReceiver.deletedCourseOfferings() is invoked when the specified course offering is deleted or removed from this course catalog.

Parametersosid.id.IdcourseOfferingIdthe Id of the CourseOffering to monitor
ErrorsNULL_ARGUMENT courseOfferingId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.