public interface ActivityRegistrationNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to ActivityRegistration
objects in this
CourseCatalog.
This also includes existing activity registrations
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 views defined in this session correspond to the views in the
ActivityRegistrationLookupSession.
Modifier and Type | Method and Description |
---|---|
void |
acknowledgeActivityRegistrationNotification(Id notificationId)
Acknowledge an activity registration notification.
|
boolean |
canRegisterForActivityRegistrationNotifications()
Tests if this user can register for
ActivityRegistration
notifications. |
CourseCatalog |
getCourseCatalog()
Gets the
CourseCatalog associated with this session. |
Id |
getCourseCatalogId()
Gets the
CourseCatalog Id associated
with this session. |
void |
registerForChangedActivityRegistration(Id activityRegistrationId)
Registers for notification of an updated activity registration.
|
void |
registerForChangedActivityRegistrations()
Registers for notification of updated activity registrations.
|
void |
registerForChangedActivityRegistrationsForActivity(Id activityId)
Registers for notification of updated activity registrations for the
given activity.
|
void |
registerForChangedActivityRegistrationsForRegistration(Id registrationId)
Registers for notification of updated activity registrations for the
given registration.
|
void |
registerForChangedActivityRegistrationsForStudent(Id resourceId)
Registers for notification of updated activity registrations for the
given student.
|
void |
registerForDeletedActivityRegistration(Id activityRegistrationId)
Registers for notification of a deleted activity registration.
|
void |
registerForDeletedActivityRegistrations()
Registers for notification of deleted activity registrations.
|
void |
registerForDeletedActivityRegistrationsForActivity(Id activityId)
Registers for notification of deleted activity registrations for the
given activity.
|
void |
registerForDeletedActivityRegistrationsForRegistration(Id registrationId)
Registers for notification of deleted activity registrations for the
given registration.
|
void |
registerForDeletedActivityRegistrationsForStudent(Id resourceId)
Registers for notification of deleted activity registrations for the
given student.
|
void |
registerForNewActivityRegistrations()
Register for notifications of new activity registrations.
|
void |
registerForNewActivityRegistrationsForActivity(Id activityId)
Register for notifications of new registrations for the given
activity.
|
void |
registerForNewActivityRegistrationsForRegistration(Id registrationId)
Register for notifications of new registrations for the given
registration.
|
void |
registerForNewActivityRegistrationsForStudent(Id resourceId)
Register for notifications of new registrations for the given student.
|
void |
reliableActivityRegistrationNotifications()
Reliable notifications are desired.
|
void |
unreliableActivityRegistrationNotifications()
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 canRegisterForActivityRegistrationNotifications()
ActivityRegistration
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 reliableActivityRegistrationNotifications()
acknowledgeActivityRegistrationNotification()
.mandatory
- This method is must be implemented. void unreliableActivityRegistrationNotifications()
mandatory
- This method is must be implemented. void acknowledgeActivityRegistrationNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
notificationId
- the Id
of the notificationOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewActivityRegistrations() throws OperationFailedException, PermissionDeniedException
ActivityRegistrationReceiver.newActivityRegistrations()
is
invoked when a new ActivityRegistration
appears in this
course catalog.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewActivityRegistrationsForRegistration(Id registrationId) throws OperationFailedException, PermissionDeniedException
ActivityRegistrationReceiver.newActivityRegistrations()
is
invoked when a new ActivityRegistration
appears in this
course catalog.registrationId
- the Id
of the
Registration
to monitorNullArgumentException
- registrationId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewActivityRegistrationsForActivity(Id activityId) throws OperationFailedException, PermissionDeniedException
ActivityRegistrationReceiver.newActivityRegistrations()
is
invoked when a new ActivityRegistration
appears in 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. void registerForNewActivityRegistrationsForStudent(Id resourceId) throws OperationFailedException, PermissionDeniedException
ActivityRegistrationnReceiver.newActivityRegistrations()
is invoked when a new ActivityRegistration
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 registerForChangedActivityRegistrations() throws OperationFailedException, PermissionDeniedException
ActivityRegistrationReceiver.changedActivityRegistrations()
is
invoked when a course in this course catalog is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedActivityRegistrationsForRegistration(Id registrationId) throws OperationFailedException, PermissionDeniedException
ActivityRegistrationReceiver.changedActivityRegistrations()
is
invoked when a course in this course catalog is changed.registrationId
- the Id
of the
Regitsration
to monitorNullArgumentException
- registrationId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedActivityRegistrationsForActivity(Id activityId) throws OperationFailedException, PermissionDeniedException
ActivityRegistrationReceiver.changedActivityRegistrations()
is
invoked when a course 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 registerForChangedActivityRegistrationsForStudent(Id resourceId) throws OperationFailedException, PermissionDeniedException
ActivityRegistrationReceiver.changedActivityRegistrations()
is
invoked when a course 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 registerForChangedActivityRegistration(Id activityRegistrationId) throws OperationFailedException, PermissionDeniedException
ActivityRegistrationReceiver.changedActivityRegistrations()
is
invoked when the specified activity registration in this course
catalog is changed.activityRegistrationId
- the Id
of the
ActivityRegistration
to monitorNullArgumentException
- activityRegistrationId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedActivityRegistrations() throws OperationFailedException, PermissionDeniedException
ActivityRegistrationReceiver.deletedActivityRegistrations()
is
invoked when an activity registration is deleted or removed from this
course catalog.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedActivityRegistrationsForRegistration(Id registrationId) throws OperationFailedException, PermissionDeniedException
ActivityRegistrationReceiver.deletedActivityRegistrations()
is
invoked when an activity registration is deleted or removed from this
course catalog.registrationId
- the Id
of the
Registration
to monitorNullArgumentException
- registrationId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedActivityRegistrationsForActivity(Id activityId) throws OperationFailedException, PermissionDeniedException
ActivityRegistrationReceiver.deletedActivityRegistrations()
is
invoked when an activity registration 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. void registerForDeletedActivityRegistrationsForStudent(Id resourceId) throws OperationFailedException, PermissionDeniedException
ActivityRegistrationReceiver.deletedActivityRegistrations()
is
invoked when an activity registration is deleted or removed from 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 registerForDeletedActivityRegistration(Id activityRegistrationId) throws OperationFailedException, PermissionDeniedException
ActivityRegistrationReceiver.deletedActivityRegistrations()
is
invoked when the specified activity registration is deleted or removed
from this course catalog.activityRegistrationId
- the Id
of the
ActivityRegistration
to monitorNullArgumentException
- activityRegistrationId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.