Interface | osid.course.CourseOfferingNotificationSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods to receive notifications on
adds/changes to The two views defined in this session correspond to the
views in the | ||
Method | getCourseCatalogId | ||
Description |
Gets the | ||
Return | osid.id.Id | the CourseCatalog Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getCourseCatalog | ||
Description |
Gets the | ||
Return | osid.course.CourseCatalog | the course catalog | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canRegisterForCourseOfferingNotifications | ||
Description |
Tests if this user can register for | ||
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 offerings 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 | reliableCourseOfferingNotifications | ||
Description |
Reliable notifications are desired. In reliable mode,
notifications are to be acknowledged using | ||
Compliance | mandatory | This method is must be implemented. | |
Method | unreliableCourseOfferingNotifications | ||
Description |
Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | acknowledgeCourseOfferingNotification | ||
Description |
Acknowledge a course offering notification. | ||
Parameters | osid.id.Id | notificationId | the Id of the notification |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForNewCourseOfferings | ||
Description |
Register for notifications of new course offerings.
| ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForNewCourseOfferingsForCourse | ||
Description |
Registers for notification of a new course offering for
a given course. | ||
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 | registerForNewCourseOfferingsForTerm | ||
Description |
Registers for notification of a new course offering for
a given term. | ||
Parameters | osid.id.Id | termId | the Id of the Term to monitor |
Errors | NULL_ARGUMENT | termId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedCourseOfferings | ||
Description |
Registers for notification of updated courses. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedCourseOfferingsForCourse | ||
Description |
Registers for notification of a changed course offering
for a given course. | ||
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 | registerForChangedCourseOfferingsForTerm | ||
Description |
Registers for notification of a changed course offering
for a given term. | ||
Parameters | osid.id.Id | termId | the Id of the Term to monitor |
Errors | NULL_ARGUMENT | termId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedCourseOffering | ||
Description |
Registers for notification of an updated course
offering. | ||
Parameters | osid.id.Id | courseOfferingId | the Id of the CourseOffering to monitor |
Errors | NULL_ARGUMENT | courseOfferingId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedCourseOfferings | ||
Description |
Registers for notification of deleted courses. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedCourseOfferingsForCourse | ||
Description |
Registers for notification of a deleted course offering
for a given course. | ||
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 | registerForDeletedCourseOfferingsForTerm | ||
Description |
Registers for notification of a deleted course offering
for a given term. | ||
Parameters | osid.id.Id | termId | the Id of the Term to monitor |
Errors | NULL_ARGUMENT | termId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedCourseOffering | ||
Description |
Registers for notification of a deleted course
offering. | ||
Parameters | osid.id.Id | courseOfferingId | the Id of the CourseOffering to monitor |
Errors | NULL_ARGUMENT | courseOfferingId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |