org.osid.course

Interface CourseNotificationSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface CourseNotificationSession
extends OsidSession

This session defines methods to receive notifications on adds/changes to Course 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 CourseLookupSession.

Method Summary

Methods

Modifier and Type	Method and Description
void	acknowledgeCourseNotification(Id notificationId) Acknowledge a course notification.
boolean	canRegisterForCourseNotifications() Tests if this user can register for Course notifications.
CourseCatalog	getCourseCatalog() Gets the CourseCatalog associated with this session.
Id	getCourseCatalogId() Gets the CourseCatalog Id associated with this session.
void	registerForChangedCourse(Id courseId) Registers for notification of an updated course.
void	registerForChangedCourses() Registers for notification of updated courses.
void	registerForDeletedCourse(Id courseId) Registers for notification of a deleted course.
void	registerForDeletedCourses() Registers for notification of deleted courses.
void	registerForNewCourses() Register for notifications of new courses.
void	reliableCourseNotifications() Reliable notifications are desired.
void	unreliableCourseNotifications() Unreliable notifications are desired.
void	useFederatedCourseCatalogView() Federates the view for methods in this session.
void	useIsolatedCourseCatalogView() Isolates the view for methods in this session.

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getCourseCatalogId

Id getCourseCatalogId()

Gets the CourseCatalog Id associated with this session.

Returns:

the CourseCatalog Id associated with this session

Compliance:

mandatory - This method must be implemented.

getCourseCatalog

CourseCatalog getCourseCatalog()
                               throws OperationFailedException,
                                      PermissionDeniedException

Gets the CourseCatalog associated with this session.

Returns:

the course catalog

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canRegisterForCourseNotifications

boolean canRegisterForCourseNotifications()

Tests if this user can register for Course 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.

Returns:

false if notification methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useFederatedCourseCatalogView

void useFederatedCourseCatalogView()

Federates the view for methods in this session. A federated view will include courses in catalogs which are children of this catalog in the course catalog hierarchy.

Compliance:

mandatory - This method is must be implemented.

useIsolatedCourseCatalogView

void useIsolatedCourseCatalogView()

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.

reliableCourseNotifications

void reliableCourseNotifications()

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

Compliance:

mandatory - This method is must be implemented.

unreliableCourseNotifications

void unreliableCourseNotifications()

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

Compliance:

mandatory - This method is must be implemented.

acknowledgeCourseNotification

void acknowledgeCourseNotification(Id notificationId)
                                   throws OperationFailedException,
                                          PermissionDeniedException

Acknowledge a course notification.

Parameters:

notificationId - the Id of the notification

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForNewCourses

void registerForNewCourses()
                           throws OperationFailedException,
                                  PermissionDeniedException

Register for notifications of new courses. CourseReceiver.newCourses() is invoked when a new Course appears in this course catalog.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedCourses

void registerForChangedCourses()
                               throws OperationFailedException,
                                      PermissionDeniedException

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

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedCourse

void registerForChangedCourse(Id courseId)
                              throws OperationFailedException,
                                     PermissionDeniedException

Registers for notification of an updated course. CourseReceiver.changedCourses() is invoked when the specified course in this course catalog is changed.

Parameters:

courseId - the Id of the Course to monitor

Throws:

NullArgumentException - courseId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedCourses

void registerForDeletedCourses()
                               throws OperationFailedException,
                                      PermissionDeniedException

Registers for notification of deleted courses. CourseReceiver.deletedCourses() is invoked when a course is deleted or removed from this course catalog.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedCourse

void registerForDeletedCourse(Id courseId)
                              throws OperationFailedException,
                                     PermissionDeniedException

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

Parameters:

courseId - the Id of the Course to monitor

Throws:

NullArgumentException - courseId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.