org.osid.course.registration

Interface ActivityRegistrationNotificationSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

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.

Method Summary

Methods

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.

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getCourseCatalogId

Id getCourseCatalogId()

Gets the CourseCatalog Id associated with this session.

Returns:

the CourseCatalog Id associated with this session

Compliance:

mandatory - This method must be implemented.

getCourseCatalog

CourseCatalog getCourseCatalog()
                               throws OperationFailedException,
                                      PermissionDeniedException

Gets the CourseCatalog associated with this session.

Returns:

the course catalog

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canRegisterForActivityRegistrationNotifications

boolean canRegisterForActivityRegistrationNotifications()

Tests if this user can register for 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.

Returns:

false if notification methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useFederatedCourseCatalogView

void useFederatedCourseCatalogView()

Federates the view for methods in this session. A federated view will include activity registrations in catalogs which are children of this catalog in the course catalog hierarchy.

Compliance:

mandatory - This method is must be implemented.

useIsolatedCourseCatalogView

void useIsolatedCourseCatalogView()

Isolates the view for methods in this session. An isolated view restricts notifications to this course catalog only.

Compliance:

mandatory - This method is must be implemented.

reliableActivityRegistrationNotifications

void reliableActivityRegistrationNotifications()

Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using acknowledgeActivityRegistrationNotification() .

Compliance:

mandatory - This method is must be implemented.

unreliableActivityRegistrationNotifications

void unreliableActivityRegistrationNotifications()

Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.

Compliance:

mandatory - This method is must be implemented.

acknowledgeActivityRegistrationNotification

void acknowledgeActivityRegistrationNotification(Id notificationId)
                                                 throws OperationFailedException,
                                                        PermissionDeniedException

Acknowledge an activity registration notification.

Parameters:

notificationId - the Id of the notification

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForNewActivityRegistrations

void registerForNewActivityRegistrations()
                                         throws OperationFailedException,
                                                PermissionDeniedException

Register for notifications of new activity registrations. ActivityRegistrationReceiver.newActivityRegistrations() is invoked when a new ActivityRegistration appears in this course catalog.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForNewActivityRegistrationsForRegistration

void registerForNewActivityRegistrationsForRegistration(Id registrationId)
                                                        throws OperationFailedException,
                                                               PermissionDeniedException

Register for notifications of new registrations for the given registration. ActivityRegistrationReceiver.newActivityRegistrations() is invoked when a new ActivityRegistration appears in this course catalog.

Parameters:

registrationId - the Id of the Registration to monitor

Throws:

NullArgumentException - registrationId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForNewActivityRegistrationsForActivity

void registerForNewActivityRegistrationsForActivity(Id activityId)
                                                    throws OperationFailedException,
                                                           PermissionDeniedException

Register for notifications of new registrations for the given activity. ActivityRegistrationReceiver.newActivityRegistrations() is invoked when a new ActivityRegistration appears in this course catalog.

Parameters:

activityId - the Id of the Activity to monitor

Throws:

NullArgumentException - activityId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForNewActivityRegistrationsForStudent

void registerForNewActivityRegistrationsForStudent(Id resourceId)
                                                   throws OperationFailedException,
                                                          PermissionDeniedException

Register for notifications of new registrations for the given student. ActivityRegistrationnReceiver.newActivityRegistrations() is invoked when a new ActivityRegistration appears in this course catalog.

Parameters:

resourceId - the Id of the Resource to monitor

Throws:

NullArgumentException - resourceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedActivityRegistrations

void registerForChangedActivityRegistrations()
                                             throws OperationFailedException,
                                                    PermissionDeniedException

Registers for notification of updated activity registrations. ActivityRegistrationReceiver.changedActivityRegistrations() is invoked when a course in this course catalog is changed.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedActivityRegistrationsForRegistration

void registerForChangedActivityRegistrationsForRegistration(Id registrationId)
                                                            throws OperationFailedException,
                                                                   PermissionDeniedException

Registers for notification of updated activity registrations for the given registration. ActivityRegistrationReceiver.changedActivityRegistrations() is invoked when a course in this course catalog is changed.

Parameters:

registrationId - the Id of the Regitsration to monitor

Throws:

NullArgumentException - registrationId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedActivityRegistrationsForActivity

void registerForChangedActivityRegistrationsForActivity(Id activityId)
                                                        throws OperationFailedException,
                                                               PermissionDeniedException

Registers for notification of updated activity registrations for the given activity. ActivityRegistrationReceiver.changedActivityRegistrations() is invoked when a course in this course catalog is changed.

Parameters:

activityId - the Id of the Activity to monitor

Throws:

NullArgumentException - activityId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedActivityRegistrationsForStudent

void registerForChangedActivityRegistrationsForStudent(Id resourceId)
                                                       throws OperationFailedException,
                                                              PermissionDeniedException

Registers for notification of updated activity registrations for the given student. ActivityRegistrationReceiver.changedActivityRegistrations() is invoked when a course in this course catalog is changed.

Parameters:

resourceId - the Id of the Resource to monitor

Throws:

NullArgumentException - resourceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedActivityRegistration

void registerForChangedActivityRegistration(Id activityRegistrationId)
                                            throws OperationFailedException,
                                                   PermissionDeniedException

Registers for notification of an updated activity registration. ActivityRegistrationReceiver.changedActivityRegistrations() is invoked when the specified activity registration in this course catalog is changed.

Parameters:

activityRegistrationId - the Id of the ActivityRegistration to monitor

Throws:

NullArgumentException - activityRegistrationId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedActivityRegistrations

void registerForDeletedActivityRegistrations()
                                             throws OperationFailedException,
                                                    PermissionDeniedException

Registers for notification of deleted activity registrations. ActivityRegistrationReceiver.deletedActivityRegistrations() is invoked when an activity registration is deleted or removed from this course catalog.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedActivityRegistrationsForRegistration

void registerForDeletedActivityRegistrationsForRegistration(Id registrationId)
                                                            throws OperationFailedException,
                                                                   PermissionDeniedException

Registers for notification of deleted activity registrations for the given registration. ActivityRegistrationReceiver.deletedActivityRegistrations() is invoked when an activity registration is deleted or removed from this course catalog.

Parameters:

registrationId - the Id of the Registration to monitor

Throws:

NullArgumentException - registrationId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedActivityRegistrationsForActivity

void registerForDeletedActivityRegistrationsForActivity(Id activityId)
                                                        throws OperationFailedException,
                                                               PermissionDeniedException

Registers for notification of deleted activity registrations for the given activity. ActivityRegistrationReceiver.deletedActivityRegistrations() is invoked when an activity registration is deleted or removed from this course catalog.

Parameters:

activityId - the Id of the Activity to monitor

Throws:

NullArgumentException - activityId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedActivityRegistrationsForStudent

void registerForDeletedActivityRegistrationsForStudent(Id resourceId)
                                                       throws OperationFailedException,
                                                              PermissionDeniedException

Registers for notification of deleted activity registrations for the given student. ActivityRegistrationReceiver.deletedActivityRegistrations() is invoked when an activity registration is deleted or removed from this course catalog.

Parameters:

resourceId - the Id of the Resource to monitor

Throws:

NullArgumentException - resourceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedActivityRegistration

void registerForDeletedActivityRegistration(Id activityRegistrationId)
                                            throws OperationFailedException,
                                                   PermissionDeniedException

Registers for notification of a deleted activity registration. ActivityRegistrationReceiver.deletedActivityRegistrations() is invoked when the specified activity registration is deleted or removed from this course catalog.

Parameters:

activityRegistrationId - the Id of the ActivityRegistration to monitor

Throws:

NullArgumentException - activityRegistrationId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.