public interface TodoNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to Todo
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.
Modifier and Type | Method and Description |
---|---|
boolean |
canRegisterForTodoNotifications()
Tests if this user can register for
Todo notifications. |
Checklist |
getChecklist()
Gets the
Checklist associated with this session. |
Id |
getChecklistId()
Gets the
Checklist Id associated with
this session. |
void |
registerForChangedTodo(Id todoId)
Registers for notification of an updated todo.
|
void |
registerForChangedTodos()
Registers for notification of updated todos.
|
void |
registerForDeletedTodo(Id todoId)
Registers for notification of a deleted todo.
|
void |
registerForDeletedTodoAncestors(Id todoId)
Register for notifications of new todos for a descendant of the
specified todo.
|
void |
registerForDeletedTodoDescendants(Id todoId)
Register for notifications of deleted todos for a descendant of the
specified todo.
|
void |
registerForDeletedTodos()
Registers for notification of deleted todos.
|
void |
registerForNewTodoAncestors(Id todoId)
Register for notifications of new todos for an ancestor of the
specified todo.
|
void |
registerForNewTodoDescendants(Id todoId)
Register for notifications of new todos for a descendant of the
specified todo.
|
void |
registerForNewTodos()
Register for notifications of new todos.
|
void |
useFederatedChecklistView()
Federates the view for methods in this session.
|
void |
useIsolatedChecklistView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getChecklistId()
Checklist
Id
associated with
this session. Checklist Id
associated with this sessionmandatory
- This method must be implemented. Checklist getChecklist() throws OperationFailedException, PermissionDeniedException
Checklist
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canRegisterForTodoNotifications()
Todo
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 useFederatedChecklistView()
mandatory
- This method is must be implemented. void useIsolatedChecklistView()
mandatory
- This method is must be implemented. void registerForNewTodos() throws OperationFailedException, PermissionDeniedException
TodoReceiver.newTodo()
is invoked when a new Todo
is created.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewTodoAncestors(Id todoId) throws OperationFailedException, PermissionDeniedException
TodoReceiver.newTodo()
is invoked when
a new Todo
is created.todoId
- the Id
of the Todo
to
monitorNullArgumentException
- todoId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewTodoDescendants(Id todoId) throws OperationFailedException, PermissionDeniedException
TodoReceiver.newTodo()
is invoked when
a new Todo
is created.todoId
- the Id
of the Todo
to
monitorNullArgumentException
- todoId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedTodos() throws OperationFailedException, PermissionDeniedException
TodoReceiver.changedTodo()
is invoked when a todo is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedTodo(Id todoId) throws OperationFailedException, PermissionDeniedException
TodoReceiver.changedTodo()
is invoked when the specified todo
is changed.todoId
- the Id
of the Todo
to
monitorNullArgumentException
- todoId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedTodos() throws OperationFailedException, PermissionDeniedException
TodoReceiver.deletedTodo()
is invoked when a todo is deleted.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedTodoAncestors(Id todoId) throws OperationFailedException, PermissionDeniedException
TodoReceiver.deletedTodo()
is invoked
when a new Todo
is created.todoId
- the Id
of the Todo
to
monitorNullArgumentException
- todoId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedTodoDescendants(Id todoId) throws OperationFailedException, PermissionDeniedException
TodoReceiver.deletedTodo()
is invoked
when a new Todo
is created.todoId
- the Id
of the Todo
to
monitorNullArgumentException
- todoId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedTodo(Id todoId) throws OperationFailedException, PermissionDeniedException
TodoReceiver.deletedTodo()
is invoked when the specified todo
is deleted.todoId
- the Id
of the Todo
to
monitorNullArgumentException
- todoId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.