public interface CourseEntryNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to CourseEntry
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
CourseEntryLookupSession.
Modifier and Type | Method and Description |
---|---|
void |
acknowledgeCourseEntryNotification(Id notificationId)
Acknowledge a course entry notification.
|
boolean |
canRegisterForCourseEntryNotifications()
Tests if this user can register for
CourseEntry
notifications. |
CourseCatalog |
getCourseCatalog()
Gets the
CourseCatalog associated with this session. |
Id |
getCourseCatalogId()
Gets the
CourseCatalog Id associated
with this session. |
void |
registerForChangedCourseEntries()
Registers for notification of updated course entries.
|
void |
registerForChangedCourseEntriesForCourse(Id courseId)
Registers for notification of updated course entries for the given
course.
|
void |
registerForChangedCourseEntriesForStudent(Id resourceId)
Registers for notification of updated course entries for the given
student.
|
void |
registerForChangedCourseEntry(Id courseEntryId)
Registers for notification of an updated course entry.
|
void |
registerForDeletedCourseEntries()
Registers for notification of deleted course entries.
|
void |
registerForDeletedCourseEntriesForCourse(Id courseId)
Registers for notification of deleted course entries for the given
course.
|
void |
registerForDeletedCourseEntriesForStudent(Id resourceId)
Registers for notification of deleted course entries for the given
student.
|
void |
registerForDeletedCourseEntry(Id courseEntryId)
Registers for notification of a deleted course entry.
|
void |
registerForNewCourseEntries()
Register for notifications of new course entries.
|
void |
registerForNewCourseEntriesForCourse(Id courseId)
Registers for notification of new course entries for the given course.
|
void |
registerForNewCourseEntriesForStudent(Id resourceId)
Registers for notification of new course entries for the given
student.
|
void |
reliableCourseEntryNotifications()
Reliable notifications are desired.
|
void |
unreliableCourseEntryNotifications()
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 canRegisterForCourseEntryNotifications()
CourseEntry
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 reliableCourseEntryNotifications()
acknowledgeCourseEntryNotification()
.mandatory
- This method is must be implemented. void unreliableCourseEntryNotifications()
mandatory
- This method is must be implemented. void acknowledgeCourseEntryNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
notificationId
- the Id
of the notificationOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewCourseEntries() throws OperationFailedException, PermissionDeniedException
CourseEntryReceiver.newCourseEntries()
is invoked when a new
CourseEntry
appears in this course catalog.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewCourseEntriesForStudent(Id resourceId) throws OperationFailedException, PermissionDeniedException
CourseEntryReceiver.newCourseEntries()
is
invoked when a new course entry appears in this course catalog.resourceId
- the Id
of the Resource
to monitorNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewCourseEntriesForCourse(Id courseId) throws OperationFailedException, PermissionDeniedException
CourseEntryReceiver.newCourseEntries()
is invoked when
a course entry appears in this course catalog.courseId
- the Id
of the Course
to
monitorNullArgumentException
- courseId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedCourseEntries() throws OperationFailedException, PermissionDeniedException
CourseEntryReceiver.changedCourseEntries()
is invoked when a
course entry in this course catalog is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedCourseEntriesForStudent(Id resourceId) throws OperationFailedException, PermissionDeniedException
CourseEntryReceiver.changedCourseEntries()
is
invoked when a course entry in this course catalog is changed.resourceId
- the Id
of the Resource
to monitorNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedCourseEntriesForCourse(Id courseId) throws OperationFailedException, PermissionDeniedException
CourseEntryReceiver.changedCourseEntries()
is
invoked when a course entry in this course catalog is changed.courseId
- the Id
of the Course
to
monitorNullArgumentException
- courseId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedCourseEntry(Id courseEntryId) throws OperationFailedException, PermissionDeniedException
CourseEntryReceiver.changedCourseEntries()
is invoked when the
specified course entry in this course catalog is changed.courseEntryId
- the Id
of the CourseEntry
to monitorNullArgumentException
- courseEntryId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedCourseEntries() throws OperationFailedException, PermissionDeniedException
CourseEntryReceiver.deletedCourseEntries()
is invoked when a
course entry is deleted or removed from this course catalog.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedCourseEntriesForStudent(Id resourceId) throws OperationFailedException, PermissionDeniedException
CourseEntryReceiver.deletedCourseEntries()
is
invoked when a course entry in this course catalog is removed or
deleted.resourceId
- the Id
of the Resource
to monitorNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedCourseEntriesForCourse(Id courseId) throws OperationFailedException, PermissionDeniedException
CourseEntryReceiver.deletedCourseEntries()
is
invoked when a course entry in this course catalog is removed or
deleted.courseId
- the Id
of the Course
to
monitorNullArgumentException
- courseId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedCourseEntry(Id courseEntryId) throws OperationFailedException, PermissionDeniedException
CourseEntryReceiver.deletedCourseEntries()
is invoked when the
specified course entry is deleted or removed from this course catalog.courseEntryId
- the Id
of the CourseEntry
to monitorNullArgumentException
- courseEntryId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.