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.
Modifier and Type | Method and Description |
---|---|
boolean |
canRegisterForChecklistNotifications()
Tests if this user can register for
Checklist
notifications. |
void |
registerForChangedChecklist(Id checklistId)
Registers for notification of an updated checklist.
|
void |
registerForChangedChecklists()
Registers for notification of updated checklists.
|
void |
registerForDeletedChecklist(Id checklistId)
Registers for notification of a deleted checklist.
|
void |
registerForDeletedChecklistAncestors(Id checklistId)
Registers for notification of an updated hierarchy structure that
removes an ancestor of the specified checklist
ChecklistReceiver.deletedAncestor() is invoked when the
specified checklist node loses an ancestor. |
void |
registerForDeletedChecklistDescendants(Id checklistId)
Registers for notification of an updated hierarchy structure that
removes a descendant of the specified checklist.
|
void |
registerForDeletedChecklists()
Registers for notification of deleted checklists.
|
void |
registerForNewChecklistAncestors(Id checklistId)
Registers for notification of an updated hierarchy structure that
introduces a new ancestor of the specified checklist.
|
void |
registerForNewChecklistDescendants(Id checklistId)
Registers for notification of an updated hierarchy structure that
introduces a new descendant of the specified checklist.
|
void |
registerForNewChecklists()
Register for notifications of new checklists.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canRegisterForChecklistNotifications()
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. false
if notification methods are not
authorized, true
otherwisemandatory
- This method must be implemented. void registerForNewChecklists() throws OperationFailedException, PermissionDeniedException
ChecklistReceiver.newChecklist()
is invoked when a new
Checklist
is created.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewChecklistAncestors(Id checklistId) throws OperationFailedException, PermissionDeniedException
ChecklistReceiver.newAncestorChecklist()
is invoked when the
specified checklist node gets a new ancestor.checklistId
- the Id
of the Checklist
node to monitorNullArgumentException
- checklistId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewChecklistDescendants(Id checklistId) throws OperationFailedException, PermissionDeniedException
ChecklistReceiver.newDescendantChecklist()
is invoked when the
specified checklist node gets a new descendant.checklistId
- the Id
of the Checklist
node to monitorNullArgumentException
- checklistId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedChecklists() throws OperationFailedException, PermissionDeniedException
ChecklistReceiver.changedChecklist()
is invoked when a
checklist is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedChecklist(Id checklistId) throws OperationFailedException, PermissionDeniedException
ChecklistReceiver.changedChecklist()
is invoked when the
specified checklist is changed.checklistId
- the Id
of the Checklist
to monitorNullArgumentException
- checklistId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedChecklists() throws OperationFailedException, PermissionDeniedException
ChecklistReceiver.deletedChecklist()
is invoked when a
checklist is deleted.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedChecklist(Id checklistId) throws OperationFailedException, PermissionDeniedException
ChecklistReceiver.deletedChecklist()
is invoked when the
specified checklist is deleted.checklistId
- the Id
of the Checklist
to monitorNullArgumentException
- checklistId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedChecklistAncestors(Id checklistId) throws OperationFailedException, PermissionDeniedException
ChecklistReceiver.deletedAncestor()
is invoked when the
specified checklist node loses an ancestor.checklistId
- the Id
of the Checklist
to monitorNullArgumentException
- checklistId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedChecklistDescendants(Id checklistId) throws OperationFailedException, PermissionDeniedException
ChecklistReceiver.deletedDescendant()
is invoked when the
specified checklist node loses a descendant.checklistId
- the Id
of the Checklist
to monitorNullArgumentException
- checklistId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.