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.
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.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getCourseCatalogId()
CourseCatalog
Id
associated
with this session. CourseCatalog Id
associated with this
sessionmandatory
- This method must be implemented. CourseCatalog getCourseCatalog() throws OperationFailedException, PermissionDeniedException
CourseCatalog
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canRegisterForActivityBundleNotifications()
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. false
if notification methods are not
authorized, true
otherwisemandatory
- This method must be implemented. void useFederatedCourseCatalogView()
mandatory
- This method is must be implemented. void useIsolatedCourseCatalogView()
mandatory
- This method is must be implemented. void reliableActivityBundleNotifications()
acknowledgeActivityBundleNotification()
.mandatory
- This method is must be implemented. void unreliableActivityBundleNotifications()
mandatory
- This method is must be implemented. void acknowledgeActivityBundleNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
notificationId
- the Id
of the notificationOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewActivityBundles() throws OperationFailedException, PermissionDeniedException
ActivityBundleReceiver.newActivityBundles()
is invoked when a
new ActivityBundle
appears in this course catalog.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewActivityBundlesForCourseOffering(Id courseOfferingId) throws OperationFailedException, PermissionDeniedException
ActivityBundleReceiver.newActivityBundles()
is invoked when a new ActivityBundle
appears in
this course catalog.courseOfferingId
- the Id
of a
CourseOffering
NullArgumentException
- courseOfferingId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewActivityBundlesForActivity(Id activityId) throws OperationFailedException, PermissionDeniedException
ActivityBundleReceiver.newActivityBundles()
is invoked when a new ActivityBundle
appears in this
course catalog.activityId
- the Id
of an activityNullArgumentException
- activityId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedActivityBundles() throws OperationFailedException, PermissionDeniedException
ActivityBundleReceiver.changedActivityBundles()
is invoked
when an activity bundle in this course catalog is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedActivityBundlesForCourseOffering(Id courseOfferingId) throws OperationFailedException, PermissionDeniedException
ActivityBundleReceiver.changedActivityBundles()
is invoked
when an activity bundle in this course catalog is changed.courseOfferingId
- the Id
of a
CourseOffering
NullArgumentException
- courseOfferingId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedActivityBundlesForActivity(Id activityId) throws OperationFailedException, PermissionDeniedException
ActivityBundleReceiver.changedActivityBundles()
is invoked when an activity bundle in this course catalog is
changed.activityId
- the Id
of an Activity
NullArgumentException
- activityId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedActivityBundle(Id activityBundleId) throws OperationFailedException, PermissionDeniedException
ActivityBundleReceiver.changedActivityBundles()
is invoked
when the specified activity bundle in this course catalog is changed.activityBundleId
- the Id
of the
ActivityBundle
to monitorNullArgumentException
- activityBundleId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedActivityBundles() throws OperationFailedException, PermissionDeniedException
ActivityBundleReceiver.deletedActivityBundles()
is invoked
when an activity bundle is deleted or removed from this course
catalog.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedActivityBundlesForCourseOffering(Id courseOfferingId) throws OperationFailedException, PermissionDeniedException
ActivityBundleReceiver.changedActivityBundles()
is invoked
when the specified activity bundle in this course catalog is changed.courseOfferingId
- the Id
of the
CourseOffering
to monitorNullArgumentException
- courseOfferingId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedActivityBundlesForActivity(Id activityId) throws OperationFailedException, PermissionDeniedException
ActivityBundleReceiver.changedActivityBundles()
is invoked when the specified activity bundle in this course
catalog is changed.activityId
- the Id
of the Activity
to monitorNullArgumentException
- activityId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedActivityBundle(Id activityBundleId) throws OperationFailedException, PermissionDeniedException
ActivityBundleReceiver.deletedActivityBundles()
is invoked
when the specified activity bundle is deleted or removed from this
course catalog.activityBundleId
- the Id
of the
ActivityBundle
to monitorNullArgumentException
- activityBundleId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.