Interface | osid.checklist.mason.TodoProducerNotificationSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods to receive notifications on
adds/changes to The two views defined in this session correspond to the
views in the | ||
Method | getChecklistId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Checklist Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getChecklist | ||
Description |
Gets the | ||
Return | osid.checklist.Checklist | the checklist | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canRegisterForTodoProducerNotifications | ||
Description |
Tests if this user can register for | ||
Return | boolean | false if notification methods are not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useFederatedChecklistView | ||
Description |
Federates the view for methods in this session. A federated view will include producers in checklists which are children of this checklist in the checklist hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedChecklistView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts notifications to this checklist only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | reliableTodoProducerNotifications | ||
Description |
Reliable notifications are desired. In reliable mode,
notifications are to be acknowledged using | ||
Compliance | mandatory | This method is must be implemented. | |
Method | unreliableTodoProducerNotifications | ||
Description |
Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | acknowledgeTodoProducerNotification | ||
Description |
Acknowledge a todo producer notification. | ||
Parameters | osid.id.Id | notificationId | the Id of the notification |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForNewTodoProducers | ||
Description |
Register for notifications of new todo producers.
| ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedTodoProducers | ||
Description |
Registers for notification of updated todo producers.
| ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedTodoProducer | ||
Description |
Registers for notification of an updated todo producer.
| ||
Parameters | osid.id.Id | todoProducerId | the Id of the TodoProducer to monitor |
Errors | NULL_ARGUMENT | todoProducerId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedTodoProducers | ||
Description |
Registers for notification of deleted todo producers.
| ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedTodoProducer | ||
Description |
Registers for notification of a deleted todo producer.
| ||
Parameters | osid.id.Id | todoProducerId | the Id of the TodoProducer to monitor |
Errors | NULL_ARGUMENT | todoProducerId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |