org.osid.course.syllabus

Interface ModuleNotificationSession

All Superinterfaces:

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

public interface ModuleNotificationSession
extends OsidSession

This session defines methods to receive notifications on adds/changes to Module 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 session is closed.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canRegisterForModuleNotifications() Tests if this user can register for Module notifications.
CourseCatalog	getCourseCatalog() Gets the CourseCatalog associated with this session.
Id	getCourseCatalogId() Gets the CourseCatalog Id associated with this session.
void	registerForChangedModule(Id moduleId) Registers for notification of an updated module.
void	registerForChangedModules() Registers for notification of updated modules.
void	registerForChangedModulesForSyllabus(Id syllabusId) Registers for notification of updated modules for the given syllabus.
void	registerForDeletedModule(Id moduleId) Registers for notification of a deleted module.
void	registerForDeletedModules() Registers for notification of deleted modules.
void	registerForDeletedModulesForSyllabus(Id syllabusId) Registers for notification of deleted modules for the given syllabus.
void	registerForNewModules() Register for notifications of new modules.
void	registerForNewModulesForSyllabus(Id syllabusId) Register for notifications of new modules for the given syllabus.
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.

canRegisterForModuleNotifications

boolean canRegisterForModuleNotifications()

Tests if this user can register for Module 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 modules in course catalogs which are children of this course 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 retrievals to this course catalog only.

Compliance:

mandatory - This method is must be implemented.

registerForNewModules

void registerForNewModules()
                           throws OperationFailedException,
                                  PermissionDeniedException

Register for notifications of new modules. ModuleReceiver.newModule() is invoked when a new Module is created.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForNewModulesForSyllabus

void registerForNewModulesForSyllabus(Id syllabusId)
                                      throws OperationFailedException,
                                             PermissionDeniedException

Register for notifications of new modules for the given syllabus. ModuleReceiver.newModule() is invoked when a new Module is created.

Parameters:

syllabusId - the Id of the Syllabus to monitor

Throws:

NullArgumentException - syllabusId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedModules

void registerForChangedModules()
                               throws OperationFailedException,
                                      PermissionDeniedException

Registers for notification of updated modules. ModuleReceiver.changedModule() is invoked when a module is changed.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedModulesForSyllabus

void registerForChangedModulesForSyllabus(Id syllabusId)
                                          throws OperationFailedException,
                                                 PermissionDeniedException

Registers for notification of updated modules for the given syllabus. ModuleReceiver.changedModule() is invoked when a module is changed.

Parameters:

syllabusId - the Id of the Syllabus to monitor

Throws:

NullArgumentException - syllabusId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedModule

void registerForChangedModule(Id moduleId)
                              throws OperationFailedException,
                                     PermissionDeniedException

Registers for notification of an updated module. ModuleReceiver.changedModule() is invoked when the specified module is changed.

Parameters:

moduleId - the Id of the Module to monitor

Throws:

NullArgumentException - moduleId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedModules

void registerForDeletedModules()
                               throws OperationFailedException,
                                      PermissionDeniedException

Registers for notification of deleted modules. ModuleReceiver.deletedModule() is invoked when a module in this catalog is deleted.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedModulesForSyllabus

void registerForDeletedModulesForSyllabus(Id syllabusId)
                                          throws OperationFailedException,
                                                 PermissionDeniedException

Registers for notification of deleted modules for the given syllabus. ModuleReceiver.deletedModule() is invoked when a module in this catalog is deleted.

Parameters:

syllabusId - the Id of the Syllabus to monitor

Throws:

NullArgumentException - syllabusId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedModule

void registerForDeletedModule(Id moduleId)
                              throws OperationFailedException,
                                     PermissionDeniedException

Registers for notification of a deleted module. ModuleReceiver.deletedModule() is invoked when the specified module in this catalog is deleted.

Parameters:

moduleId - the Id of the Module to monitor

Throws:

NullArgumentException - moduleId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.