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 |
---|---|
boolean |
canRegisterForCourseCatalogNotifications()
Tests if this user can register for
CourseCatalog
notifications. |
void |
registerForChangedCourseCatalog(Id courseCatalogId)
Registers for notification of an updated course catalog.
|
void |
registerForChangedCourseCatalogs()
Registers for notification of updated course catalogs.
|
void |
registerForDeletedCourseCatalog(Id courseCatalogId)
Registers for notification of a deleted course catalog.
|
void |
registerForDeletedCourseCatalogAncestors(Id courseCatalogId)
Registers for notification if an ancestor is removed from the
specified course catalog in the course catalog hierarchy.
|
void |
registerForDeletedCourseCatalogDescendants(Id courseCatalogId)
Registers for notification if a descendant is removed from fthe
specified course catalog in the course catalog hierarchy.
|
void |
registerForDeletedCourseCatalogs()
Registers for notification of deleted course catalogs.
|
void |
registerForNewCourseCatalogAncestors(Id courseCatalogId)
Registers for notification if an ancestor is added to the specified
course catalog in the course catalog hierarchy.
|
void |
registerForNewCourseCatalogDescendants(Id courseCatalogId)
Registers for notification if a descendant is added to the specified
course catalog in the course catalog hierarchy.
|
void |
registerForNewCourseCatalogs()
Register for notifications of new course catalogs.
|
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 registerForNewCourseCatalogs() throws OperationFailedException, PermissionDeniedException
CourseCatalogReceiver.newCourseCatalog()
is invoked when a new
CourseCatalog
is created.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewCourseCatalogAncestors(Id courseCatalogId) throws OperationFailedException, PermissionDeniedException
CourseCatalogReceiver.newCourseCatalogAncestor()
is invoked
when the specified course catalog experiences an addition in ancestry.courseCatalogId
- the Id
of the course catalog to
monitorNullArgumentException
- courseCatalogId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewCourseCatalogDescendants(Id courseCatalogId) throws OperationFailedException, PermissionDeniedException
CourseCatalogReceiver.newCourseCatalogDescendant()
is invoked
when the specified course catalog experiences an addition in
descendants.courseCatalogId
- the Id
of the course catalog to
monitorNullArgumentException
- courseCatalogId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedCourseCatalogs() throws OperationFailedException, PermissionDeniedException
CourseCatalogReceiver.changedCourseCatalog()
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.changedCourseCatalog()
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.deletedCourseCatalog()
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.deletedCourseCatalog()
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 registerForDeletedCourseCatalogAncestors(Id courseCatalogId) throws OperationFailedException, PermissionDeniedException
CourseCatalogReceiver.deletedCourseCatalogAncestor()
is
invoked when the specified course catalog experiences a removal of an
ancestor.courseCatalogId
- the Id
of the course catalog to
monitorNullArgumentException
- courseCatalogId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedCourseCatalogDescendants(Id courseCatalogId) throws OperationFailedException, PermissionDeniedException
CourseCatalogReceiver.deletedCourseCatalogDescednant()
is
invoked when the specified course catalog experiences a removal of one
of its descdendents.courseCatalogId
- the Id
of the course catalog to
monitorNullArgumentException
- courseCatalogId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.