org.osid.room

Interface CampusNotificationSession

All Superinterfaces:

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

public interface CampusNotificationSession
extends OsidSession

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

Notifications are triggered with changes to the Campus object itself. Adding and removing rooms result in notifications available from the notification session for rooms.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canRegisterForCampusNotifications() Tests if this user can register for Campus notifications.
void	registerForChangedCampus(Id campusId) Registers for notification of an updated campus.
void	registerForChangedCampuses() Registers for notification of updated campuses.
void	registerForDeletedCampus(Id campusId) Registers for notification of a deleted campus.
void	registerForDeletedCampusAncestors(Id campusId) Registers for notification of an updated hierarchy structure that removes an ancestor of the specified campus CampusReceiver.deletedAncestor() is invoked when the specified campus node loses an ancestor.
void	registerForDeletedCampusDescendants(Id campusId) Registers for notification of an updated hierarchy structure that removes a descendant of the specified campus.
void	registerForDeletedCampuses() Registers for notification of deleted campuses.
void	registerForNewCampusAncestors(Id campusId) Registers for notification of an updated hierarchy structure that introduces a new ancestor of the specified campus.
void	registerForNewCampusDescendants(Id campusId) Registers for notification of an updated hierarchy structure that introduces a new descendant of the specified campus.
void	registerForNewCampuses() Register for notifications of new campuses.

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

canRegisterForCampusNotifications

boolean canRegisterForCampusNotifications()

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

registerForNewCampuses

void registerForNewCampuses()
                            throws OperationFailedException,
                                   PermissionDeniedException

Register for notifications of new campuses. CampusReceiver.newCampus() is invoked when a new Campus is created.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForNewCampusAncestors

void registerForNewCampusAncestors(Id campusId)
                                   throws OperationFailedException,
                                          PermissionDeniedException

Registers for notification of an updated hierarchy structure that introduces a new ancestor of the specified campus. CampusReceiver.newAncestorCampus() is invoked when the specified campus node gets a new ancestor.

Parameters:

campusId - the Id of the Campus node to monitor

Throws:

NullArgumentException - campusId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForNewCampusDescendants

void registerForNewCampusDescendants(Id campusId)
                                     throws OperationFailedException,
                                            PermissionDeniedException

Registers for notification of an updated hierarchy structure that introduces a new descendant of the specified campus. CampusReceiver.newDescendantCampus() is invoked when the specified campus node gets a new descendant.

Parameters:

campusId - the Id of the Campus node to monitor

Throws:

NullArgumentException - campusId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedCampuses

void registerForChangedCampuses()
                                throws OperationFailedException,
                                       PermissionDeniedException

Registers for notification of updated campuses. CampusReceiver.changedCampus() is invoked when a campus is changed.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedCampus

void registerForChangedCampus(Id campusId)
                              throws OperationFailedException,
                                     PermissionDeniedException

Registers for notification of an updated campus. CampusReceiver.changedCampus() is invoked when the specified campus is changed.

Parameters:

campusId - the Id of the Campus to monitor

Throws:

NullArgumentException - campusId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedCampuses

void registerForDeletedCampuses()
                                throws OperationFailedException,
                                       PermissionDeniedException

Registers for notification of deleted campuses. CampusReceiver.deletedCampus() is invoked when a campus is deleted.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedCampus

void registerForDeletedCampus(Id campusId)
                              throws OperationFailedException,
                                     PermissionDeniedException

Registers for notification of a deleted campus. CampusReceiver.deletedCampus() is invoked when the specified campus is deleted.

Parameters:

campusId - the Id of the Campus to monitor

Throws:

NullArgumentException - campusId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedCampusAncestors

void registerForDeletedCampusAncestors(Id campusId)
                                       throws OperationFailedException,
                                              PermissionDeniedException

Registers for notification of an updated hierarchy structure that removes an ancestor of the specified campus CampusReceiver.deletedAncestor() is invoked when the specified campus node loses an ancestor.

Parameters:

campusId - the Id of the Campus to monitor

Throws:

NullArgumentException - campusId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedCampusDescendants

void registerForDeletedCampusDescendants(Id campusId)
                                         throws OperationFailedException,
                                                PermissionDeniedException

Registers for notification of an updated hierarchy structure that removes a descendant of the specified campus. CampusReceiver.deletedDescendant() is invoked when the specified campus node loses a descendant.

Parameters:

campusId - the Id of the Campus to monitor

Throws:

NullArgumentException - campusId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.