public interface ActivityUnitNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to ActivityUnit
objects in this CourseCatalog.
This also includes existing activity units 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
ActivityUnitLookupSession.
Modifier and Type | Method and Description |
---|---|
void |
acknowledgeActivityUnitNotification(Id notificationId)
Acknowledge an activity unit notification.
|
boolean |
canRegisterForActivityUnitNotifications()
Tests if this user can register for
ActivityUnit
notifications. |
CourseCatalog |
getCourseCatalog()
Gets the
CourseCatalog associated with this session. |
Id |
getCourseCatalogId()
Gets the
CourseCatalog Id associated
with this session. |
void |
registerForChangedActivityUnit(Id activityUnitId)
Registers for notification of an updated activity unit.
|
void |
registerForChangedActivityUnits()
Registers for notification of updated activity units.
|
void |
registerForChangedActivityUnitsForCourse(Id courseId)
Register for notifications of changed activity units for the given
course.
|
void |
registerForDeletedActivityUnit(Id activityUnitId)
Registers for notification of a deleted activity unit.
|
void |
registerForDeletedActivityUnits()
Registers for notification of deleted activity units.
|
void |
registerForDeletedActivityUnitsForCourse(Id courseId)
Register for notifications of deleted activity units for the given
course.
|
void |
registerForNewActivityUnits()
Register for notifications of new activity units.
|
void |
registerForNewActivityUnitsForCourse(Id courseId)
Register for notifications of new activity units for the given course.
|
void |
reliableActivityUnitNotifications()
Reliable notifications are desired.
|
void |
unreliableActivityUnitNotifications()
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 canRegisterForActivityUnitNotifications()
ActivityUnit
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 reliableActivityUnitNotifications()
acknowledgeActivityUnitNotification()
.mandatory
- This method is must be implemented. void unreliableActivityUnitNotifications()
mandatory
- This method is must be implemented. void acknowledgeActivityUnitNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
notificationId
- the Id
of the notificationOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewActivityUnits() throws OperationFailedException, PermissionDeniedException
ActivityUnitReceiver.newActivityUnits()
is invoked when a new
ActivityUnit
appears in this course catalog.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewActivityUnitsForCourse(Id courseId) throws OperationFailedException, PermissionDeniedException
ActivityUnitReceiver.newActivityUnits()
is invoked when
a new ActivityUnit
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 registerForChangedActivityUnits() throws OperationFailedException, PermissionDeniedException
ActivityUnitReceiver.changedActivityUnits()
is invoked when an
activity unit in this course catalog is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedActivityUnitsForCourse(Id courseId) throws OperationFailedException, PermissionDeniedException
ActivityUnitReceiver.changedActivityUnits()
is
invoked when an activity unit 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 registerForChangedActivityUnit(Id activityUnitId) throws OperationFailedException, PermissionDeniedException
ActivityUnitReceiver.changedActivityUnits()
is invoked when
the specified activity unit in this course catalog is changed.activityUnitId
- the Id
of the
ActivityUnit
to monitorNullArgumentException
- activityUnitId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedActivityUnits() throws OperationFailedException, PermissionDeniedException
ActivityUnitReceiver.deletedActivityUnits()
is invoked when an
activity unit is deleted or removed from this course catalog.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedActivityUnitsForCourse(Id courseId) throws OperationFailedException, PermissionDeniedException
ActivityUnitReceiver.changedActivityUnits()
is
invoked when an activity unit is deleted or removed from 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 registerForDeletedActivityUnit(Id activityUnitId) throws OperationFailedException, PermissionDeniedException
ActivityUnitReceiver.deletedActivityUnits()
is invoked when
the specified activity unit is deleted or removed from this course
catalog.activityUnitId
- the Id
of the
ActivityUnit
to monitorNullArgumentException
- activityUnitId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.