public interface ActivityNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to Activity
objects in this CourseCatalog.
This also includes existing activities 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
ActivityLookupSession.
Modifier and Type | Method and Description |
---|---|
void |
acknowledgeActivityNotification(Id notificationId)
Acknowledge an activity notification.
|
boolean |
canRegisterForActivityNotifications()
Tests if this user can register for
Activity
notifications. |
CourseCatalog |
getCourseCatalog()
Gets the
CourseCatalog associated with this session. |
Id |
getCourseCatalogId()
Gets the
CourseCatalog Id associated
with this session. |
void |
registerForChangedActivities()
Registers for notification of updated courses.
|
void |
registerForChangedActivitiesForActivityUnit(Id activityUnitId)
Register for notifications of updated activities of the given activity
unit.
|
void |
registerForChangedActivitiesForCourseOffering(Id courseOfferingId)
Register for notifications of updated activities of the given course
offering.
|
void |
registerForChangedActivitiesForTerm(Id termId)
Register for notifications of updated activities of the given term.
|
void |
registerForChangedActivity(Id activityId)
Registers for notification of an updated activity.
|
void |
registerForDeletedActivities()
Registers for notification of deleted activities.
|
void |
registerForDeletedActivitiesForActivityUnit(Id activityUnitId)
Register for notifications of deleted activities of the given activity
unit.
|
void |
registerForDeletedActivitiesForCourseOffering(Id courseOfferingId)
Register for notifications of deleted activities of the given course
offering.
|
void |
registerForDeletedActivitiesForTerm(Id termId)
Register for notifications of deleted activities of the given term.
|
void |
registerForDeletedActivity(Id activityId)
Registers for notification of a deleted activity.
|
void |
registerForNewActivities()
Register for notifications of new activities.
|
void |
registerForNewActivitiesForActivityUnit(Id activityUnitId)
Register for notifications of new activities of the given activity
unit.
|
void |
registerForNewActivitiesForCourseOffering(Id courseOfferingId)
Register for notifications of new activities of the given course
offering.
|
void |
registerForNewActivitiesForTerm(Id termId)
Register for notifications of new activities of the given term.
|
void |
reliableActivityNotifications()
Reliable notifications are desired.
|
void |
unreliableActivityNotifications()
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 canRegisterForActivityNotifications()
Activity
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 reliableActivityNotifications()
acknowledgeActivityNotification()
.mandatory
- This method is must be implemented. void unreliableActivityNotifications()
mandatory
- This method is must be implemented. void acknowledgeActivityNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
notificationId
- the Id
of the notificationOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewActivities() throws OperationFailedException, PermissionDeniedException
ActivityReceiver.newActivities()
is invoked when a new
Activity
appears in this course catalog.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewActivitiesForActivityUnit(Id activityUnitId) throws OperationFailedException, PermissionDeniedException
ActivityReceiver.newActivities()
is invoked when
a new Activity
appears in this course catalog.activityUnitId
- an activity unit Id
NullArgumentException
- activityUnitId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewActivitiesForCourseOffering(Id courseOfferingId) throws OperationFailedException, PermissionDeniedException
ActivityReceiver.newActivities()
is invoked
when a new Activity
appears in this course catalog.courseOfferingId
- a course offering Id
NullArgumentException
- courseOfferingId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewActivitiesForTerm(Id termId) throws OperationFailedException, PermissionDeniedException
ActivityReceiver.newActivities()
is invoked when a new
Activity
appears in this course catalog.termId
- a term Id
NullArgumentException
- termId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedActivities() throws OperationFailedException, PermissionDeniedException
ActivityReceiver.changedActivities()
is invoked when an
activity in this course catalog is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedActivitiesForActivityUnit(Id activityUnitId) throws OperationFailedException, PermissionDeniedException
ActivityReceiver.changedActivities()
is invoked
when an activity in this course catalog is changed.activityUnitId
- an activity unit Id
NullArgumentException
- activityUnitId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedActivitiesForCourseOffering(Id courseOfferingId) throws OperationFailedException, PermissionDeniedException
ActivityReceiver.changedActivities()
is
invoked when an activity in this course catalog is changed.courseOfferingId
- a course offering Id
NullArgumentException
- courseOfferingId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedActivitiesForTerm(Id termId) throws OperationFailedException, PermissionDeniedException
ActivityReceiver.changedActivities()
is invoked when an
activity in this course catalog is changed.termId
- a term Id
NullArgumentException
- termId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedActivity(Id activityId) throws OperationFailedException, PermissionDeniedException
ActivityReceiver.changedActivities()
is invoked when the
specified activity 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 registerForDeletedActivities() throws OperationFailedException, PermissionDeniedException
ActivityReceiver.deletedActivities()
is invoked when an
activity is deleted or removed from this course catalog.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedActivitiesForActivityUnit(Id activityUnitId) throws OperationFailedException, PermissionDeniedException
ActivityReceiver.deletedActivities()
is invoked
when an activity is deleted or removed from this course catalog.activityUnitId
- an activity unit Id
NullArgumentException
- activityUnitId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedActivitiesForCourseOffering(Id courseOfferingId) throws OperationFailedException, PermissionDeniedException
ActivityReceiver.deletedActivities()
is
invoked when an activity is deleted or removed from this course
catalog.courseOfferingId
- a course offering Id
NullArgumentException
- courseOfferingId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedActivitiesForTerm(Id termId) throws OperationFailedException, PermissionDeniedException
ActivityReceiver.deletedActivity()
is invoked when an
activity is deleted or removed from this course catalog.termId
- a term Id
NullArgumentException
- termId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedActivity(Id activityId) throws OperationFailedException, PermissionDeniedException
ActivityReceiver.deletedActivities()
is invoked when the
specified activity is deleted or removed from this course catalog.activityId
- the Id
of the Activity
to monitorNullArgumentException
- activityId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.