org.osid.checklist

Interface ChecklistNotificationSession

All Superinterfaces:

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

public interface ChecklistNotificationSession
extends OsidSession

This session defines methods to receive notifications on adds/changes to Checklist 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 Checklist object itself. Adding and removing todos result in notifications available from the notification session for todos.

Method Summary

Methods

Modifier and Type	Method and Description
void	acknowledgeChecklistNotification(Id notificationId) Acknowledge a checklist notification.
boolean	canRegisterForChecklistNotifications() Tests if this user can register for Checklist notifications.
void	registerForChangedChecklist(Id checklistId) Registers for notification of an updated checklist.
void	registerForChangedChecklistHierarchy() Registers for notification of an updated checklist hierarchy structure.
void	registerForChangedChecklistHierarchyForAncestors(Id checklistId) ChecklistReceiver.changedChildOfChecklists() is invoked when the specified node or any of its ancestors experiences a change in its children.
void	registerForChangedChecklistHierarchyForDescendants(Id checklistId) Registers for notification of an updated checklist hierarchy structure.
void	registerForChangedChecklists() Registers for notification of updated checklists.
void	registerForDeletedChecklist(Id checklistId) Registers for notification of a deleted checklist.
void	registerForDeletedChecklists() Registers for notification of deleted checklists.
void	registerForNewChecklists() Register for notifications of new checklists.
void	reliableChecklistNotifications() Reliable notifications are desired.
void	unreliableChecklistNotifications() Unreliable notifications are desired.

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

canRegisterForChecklistNotifications

boolean canRegisterForChecklistNotifications()

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

reliableChecklistNotifications

void reliableChecklistNotifications()

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

Compliance:

mandatory - This method is must be implemented.

unreliableChecklistNotifications

void unreliableChecklistNotifications()

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

Compliance:

mandatory - This method is must be implemented.

acknowledgeChecklistNotification

void acknowledgeChecklistNotification(Id notificationId)
                                      throws OperationFailedException,
                                             PermissionDeniedException

Acknowledge a checklist notification.

Parameters:

notificationId - the Id of the notification

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForNewChecklists

void registerForNewChecklists()
                              throws OperationFailedException,
                                     PermissionDeniedException

Register for notifications of new checklists. ChecklistReceiver.newChecklists() is invoked when a new Checklist is created.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedChecklists

void registerForChangedChecklists()
                                  throws OperationFailedException,
                                         PermissionDeniedException

Registers for notification of updated checklists. ChecklistReceiver.changedChecklists() is invoked when a checklist is changed.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedChecklist

void registerForChangedChecklist(Id checklistId)
                                 throws OperationFailedException,
                                        PermissionDeniedException

Registers for notification of an updated checklist. ChecklistReceiver.changedChecklists() is invoked when the specified checklist is changed.

Parameters:

checklistId - the Id of the Checklist to monitor

Throws:

NullArgumentException - checklistId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedChecklists

void registerForDeletedChecklists()
                                  throws OperationFailedException,
                                         PermissionDeniedException

Registers for notification of deleted checklists. ChecklistReceiver.deletedChecklists() is invoked when a checklist is deleted.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedChecklist

void registerForDeletedChecklist(Id checklistId)
                                 throws OperationFailedException,
                                        PermissionDeniedException

Registers for notification of a deleted checklist. ChecklistReceiver.deletedChecklists() is invoked when the specified checklist is deleted.

Parameters:

checklistId - the Id of the Checklist to monitor

Throws:

NullArgumentException - checklistId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedChecklistHierarchy

void registerForChangedChecklistHierarchy()
                                          throws OperationFailedException,
                                                 PermissionDeniedException

Registers for notification of an updated checklist hierarchy structure. ChecklistReceiver.changedChildOfChecklists() is invoked when a node experiences a change in its children.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedChecklistHierarchyForAncestors

void registerForChangedChecklistHierarchyForAncestors(Id checklistId)
                                                      throws OperationFailedException,
                                                             PermissionDeniedException

ChecklistReceiver.changedChildOfChecklists() is invoked when the specified node or any of its ancestors experiences a change in its children.

Parameters:

checklistId - the Id of the Checklist node to monitor

Throws:

NullArgumentException - checklistId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedChecklistHierarchyForDescendants

void registerForChangedChecklistHierarchyForDescendants(Id checklistId)
                                                        throws OperationFailedException,
                                                               PermissionDeniedException

Registers for notification of an updated checklist hierarchy structure. ChecklistReceiver.changedChildOfChecklists() is invoked when the specified node or any of its descendants experiences a change in its children.

Parameters:

checklistId - the Id of the Checklist node to monitor

Throws:

NullArgumentException - checklistId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.