org.osid.course.registration

Interface ActivityBundleNotificationSession

All Superinterfaces:

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

public interface ActivityBundleNotificationSession
extends OsidSession

This session defines methods to receive notifications on adds/changes to ActivityBundle objects in this CourseCatalog. This also includes existing activity bundles 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 ActivityBundleLookupSession.

Method Summary

Methods

Modifier and Type	Method and Description
void	acknowledgeActivityBundleNotification(Id notificationId) Acknowledge an activity bundle notification.
boolean	canRegisterForActivityBundleNotifications() Tests if this user can register for ActivityBundle notifications.
CourseCatalog	getCourseCatalog() Gets the CourseCatalog associated with this session.
Id	getCourseCatalogId() Gets the CourseCatalog Id associated with this session.
void	registerForChangedActivityBundle(Id activityBundleId) Registers for notification of an updated activity bundle.
void	registerForChangedActivityBundles() Registers for notification of updated activity bundles.
void	registerForChangedActivityBundlesForActivity(Id activityId) Registers for notification of updated activity bundles for the given activity.
void	registerForChangedActivityBundlesForCourseOffering(Id courseOfferingId) Registers for notification of updated activity bundles for the given course offering.
void	registerForDeletedActivityBundle(Id activityBundleId) Registers for notification of a deleted activity bundle.
void	registerForDeletedActivityBundles() Registers for notification of deleted activity bundles.
void	registerForDeletedActivityBundlesForActivity(Id activityId) Registers for notification of a deleted activity bundle for the given activity.
void	registerForDeletedActivityBundlesForCourseOffering(Id courseOfferingId) Registers for notification of a deleted activity bundle for the given course offering.
void	registerForNewActivityBundles() Register for notifications of new activity bundles.
void	registerForNewActivityBundlesForActivity(Id activityId) Register for notifications of new activity bundles for the given activity.
void	registerForNewActivityBundlesForCourseOffering(Id courseOfferingId) Register for notifications of new activity bundles for the given course offering.
void	reliableActivityBundleNotifications() Reliable notifications are desired.
void	unreliableActivityBundleNotifications() 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.

canRegisterForActivityBundleNotifications

boolean canRegisterForActivityBundleNotifications()

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

reliableActivityBundleNotifications

void reliableActivityBundleNotifications()

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

Compliance:

mandatory - This method is must be implemented.

unreliableActivityBundleNotifications

void unreliableActivityBundleNotifications()

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

Compliance:

mandatory - This method is must be implemented.

acknowledgeActivityBundleNotification

void acknowledgeActivityBundleNotification(Id notificationId)
                                           throws OperationFailedException,
                                                  PermissionDeniedException

Acknowledge an activity bundle notification.

Parameters:

notificationId - the Id of the notification

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForNewActivityBundles

void registerForNewActivityBundles()
                                   throws OperationFailedException,
                                          PermissionDeniedException

Register for notifications of new activity bundles. ActivityBundleReceiver.newActivityBundles() is invoked when a new ActivityBundle appears in this course catalog.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForNewActivityBundlesForCourseOffering

void registerForNewActivityBundlesForCourseOffering(Id courseOfferingId)
                                                    throws OperationFailedException,
                                                           PermissionDeniedException

Register for notifications of new activity bundles for the given course offering. ActivityBundleReceiver.newActivityBundles() is invoked when a new ActivityBundle appears in this course catalog.

Parameters:

courseOfferingId - the Id of a CourseOffering

Throws:

NullArgumentException - courseOfferingId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForNewActivityBundlesForActivity

void registerForNewActivityBundlesForActivity(Id activityId)
                                              throws OperationFailedException,
                                                     PermissionDeniedException

Register for notifications of new activity bundles for the given activity. ActivityBundleReceiver.newActivityBundles() is invoked when a new ActivityBundle appears in this course catalog.

Parameters:

activityId - the Id of an activity

Throws:

NullArgumentException - activityId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedActivityBundles

void registerForChangedActivityBundles()
                                       throws OperationFailedException,
                                              PermissionDeniedException

Registers for notification of updated activity bundles. ActivityBundleReceiver.changedActivityBundles() is invoked when an activity bundle in this course catalog is changed.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedActivityBundlesForCourseOffering

void registerForChangedActivityBundlesForCourseOffering(Id courseOfferingId)
                                                        throws OperationFailedException,
                                                               PermissionDeniedException

Registers for notification of updated activity bundles for the given course offering. ActivityBundleReceiver.changedActivityBundles() is invoked when an activity bundle in this course catalog is changed.

Parameters:

courseOfferingId - the Id of a CourseOffering

Throws:

NullArgumentException - courseOfferingId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedActivityBundlesForActivity

void registerForChangedActivityBundlesForActivity(Id activityId)
                                                  throws OperationFailedException,
                                                         PermissionDeniedException

Registers for notification of updated activity bundles for the given activity. ActivityBundleReceiver.changedActivityBundles() is invoked when an activity bundle in this course catalog is changed.

Parameters:

activityId - the Id of an Activity

Throws:

NullArgumentException - activityId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedActivityBundle

void registerForChangedActivityBundle(Id activityBundleId)
                                      throws OperationFailedException,
                                             PermissionDeniedException

Registers for notification of an updated activity bundle. ActivityBundleReceiver.changedActivityBundles() is invoked when the specified activity bundle in this course catalog is changed.

Parameters:

activityBundleId - the Id of the ActivityBundle to monitor

Throws:

NullArgumentException - activityBundleId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedActivityBundles

void registerForDeletedActivityBundles()
                                       throws OperationFailedException,
                                              PermissionDeniedException

Registers for notification of deleted activity bundles. ActivityBundleReceiver.deletedActivityBundles() is invoked when an activity bundle is deleted or removed from this course catalog.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedActivityBundlesForCourseOffering

void registerForDeletedActivityBundlesForCourseOffering(Id courseOfferingId)
                                                        throws OperationFailedException,
                                                               PermissionDeniedException

Registers for notification of a deleted activity bundle for the given course offering. ActivityBundleReceiver.changedActivityBundles() is invoked when the specified activity bundle in this course catalog is changed.

Parameters:

courseOfferingId - the Id of the CourseOffering to monitor

Throws:

NullArgumentException - courseOfferingId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedActivityBundlesForActivity

void registerForDeletedActivityBundlesForActivity(Id activityId)
                                                  throws OperationFailedException,
                                                         PermissionDeniedException

Registers for notification of a deleted activity bundle for the given activity. ActivityBundleReceiver.changedActivityBundles() is invoked when the specified activity bundle in this course catalog is changed.

Parameters:

activityId - the Id of the Activity to monitor

Throws:

NullArgumentException - activityId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedActivityBundle

void registerForDeletedActivityBundle(Id activityBundleId)
                                      throws OperationFailedException,
                                             PermissionDeniedException

Registers for notification of a deleted activity bundle. ActivityBundleReceiver.deletedActivityBundles() is invoked when the specified activity bundle is deleted or removed from this course catalog.

Parameters:

activityBundleId - the Id of the ActivityBundle to monitor

Throws:

NullArgumentException - activityBundleId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.