public interface CourseCatalogNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to CourseCatalog
objects. This session is intended for
consumers needing to synchronize their state with this service without the
use of polling. Notifications are cancelled when this sess
Modifier and Type | Method and Description |
---|---|
void |
acknowledgeCourseCatalogNotification(Id notificationId)
Acknowledge a course catalog notification.
|
boolean |
canRegisterForCourseCatalogNotifications()
Tests if this user can register for
CourseCatalog
notifications. |
void |
registerForChangedCourseCatalog(Id courseCatalogId)
Registers for notification of an updated course catalog.
|
void |
registerForChangedCourseCatalogHierarchy()
Registers for notification of an updated course catalog hierarchy
structure.
|
void |
registerForChangedCourseCatalogHierarchyForAncestors(Id courseCatalogId)
Registers for notification of an updated course catalog hierarchy
structure.
|
void |
registerForChangedCourseCatalogHierarchyForDescendants(Id courseCatalogId)
Registers for notification of an updated course catalog hierarchy
structure.
|
void |
registerForChangedCourseCatalogs()
Registers for notification of updated course catalogs.
|
void |
registerForDeletedCourseCatalog(Id courseCatalogId)
Registers for notification of a deleted course catalog.
|
void |
registerForDeletedCourseCatalogs()
Registers for notification of deleted course catalogs.
|
void |
registerForNewCourseCatalogs()
Register for notifications of new course catalogs.
|
void |
reliableCourseCatalogNotifications()
Reliable notifications are desired.
|
void |
unreliableCourseCatalogNotifications()
Unreliable notifications are desired.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canRegisterForCourseCatalogNotifications()
CourseCatalog
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 reliableCourseCatalogNotifications()
acknowledgeCourseCatalogNotification()
.mandatory
- This method is must be implemented. void unreliableCourseCatalogNotifications()
mandatory
- This method is must be implemented. void acknowledgeCourseCatalogNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
notificationId
- the Id
of the notificationOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewCourseCatalogs() throws OperationFailedException, PermissionDeniedException
CourseCatalogReceiver.newCourseCatalogs()
is invoked when a
new CourseCatalog
is created.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedCourseCatalogs() throws OperationFailedException, PermissionDeniedException
CourseCatalogReceiver.changedCourseCatalogs()
is invoked when
a course catalog is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedCourseCatalog(Id courseCatalogId) throws OperationFailedException, PermissionDeniedException
CourseCatalogReceiver.changedCourseCatalogs()
is invoked when
the specified course catalog is changed.courseCatalogId
- the Id of the CourseCatalog
to
monitorNullArgumentException
- courseCatalogId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedCourseCatalogs() throws OperationFailedException, PermissionDeniedException
CourseCatalogReceiver.deletedCourseCatalogs()
is invoked when
a course catalog is deleted.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedCourseCatalog(Id courseCatalogId) throws OperationFailedException, PermissionDeniedException
CourseCatalogReceiver.deletedCourseCatalogs()
is invoked when
the specified course catalog is deleted.courseCatalogId
- the Id of the CourseCatalog
to
monitorNullArgumentException
- courseCatalogId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedCourseCatalogHierarchy() throws OperationFailedException, PermissionDeniedException
CourseCataloReceiver.changedChildOfCourseCatalos()
is invoked when a node experiences a change in its children.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedCourseCatalogHierarchyForAncestors(Id courseCatalogId) throws OperationFailedException, PermissionDeniedException
CourseCataloReceiver.changedChildOfCourseCatalos()
is invoked when the specified node or any of its ancestors
experiences a change in its children.courseCatalogId
- the Id
of the
CourseCatalo
node to monitorNullArgumentException
- courseCatalogId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedCourseCatalogHierarchyForDescendants(Id courseCatalogId) throws OperationFailedException, PermissionDeniedException
CourseCatalogReceiver.changedChildOfCourseCatalos()
is invoked when the specified node or any of its descendants
experiences a change in its children.courseCatalogId
- the Id
of the
CourseCatalo
node to monitorNullArgumentException
- courseCatalogId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.