OSID Logo
OSID Specifications
checklist mason package
Version 3.0.0
Release Candidate Preview
Interfaceosid.checklist.mason.TodoProducerNotificationSession
Implementsosid.OsidSession
Description

This session defines methods to receive notifications on adds/changes to TodoProducer objects in this Checklist. This also includes existing TodoProducers that may appear or disappear due to changes in the Checklist hierarchy, 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.

The two views defined in this session correspond to the views in the TodoProducerLookupSession.

MethodgetChecklistId
Description

Gets the Checklist Id associated with this session.

Returnosid.id.Idthe Checklist Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetChecklist
Description

Gets the Checklist associated with this session.

Returnosid.checklist.Checklistthe checklist
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanRegisterForTodoProducerNotifications
Description

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

Returnboolean false if notification methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseFederatedChecklistView
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.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedChecklistView
Description

Isolates the view for methods in this session. An isolated view restricts notifications to this checklist only.

CompliancemandatoryThis method is must be implemented.
MethodreliableTodoProducerNotifications
Description

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

CompliancemandatoryThis method is must be implemented.
MethodunreliableTodoProducerNotifications
Description

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

CompliancemandatoryThis method is must be implemented.
MethodacknowledgeTodoProducerNotification
Description

Acknowledge a todo producer notification.

Parametersosid.id.IdnotificationIdthe Id of the notification
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewTodoProducers
Description

Register for notifications of new todo producers. TodoProducerReceiver.newTodoProducers() is invoked when a new TodoProducer appears in this checklist.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedTodoProducers
Description

Registers for notification of updated todo producers. TodoProducerReceiver.changedTodoProducers() is invoked when a todo producer in this checklist is changed.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedTodoProducer
Description

Registers for notification of an updated todo producer. ProvisionableReceiver.changedTodoProducers() is invoked when the specified todo producer in this checklist is changed.

Parametersosid.id.IdtodoProducerIdthe Id of the TodoProducer to monitor
ErrorsNULL_ARGUMENT todoProducerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedTodoProducers
Description

Registers for notification of deleted todo producers. TodoProducerReceiver.deletedTodoProducers() is invoked when a todo producer is deleted or removed from this checklist.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedTodoProducer
Description

Registers for notification of a deleted todo producer. TodoProducerReceiver.deletedTodoProducers() is invoked when the specified todo producer is deleted or removed from this checklist.

Parametersosid.id.IdtodoProducerIdthe Id of the TodoProducer to monitor
ErrorsNULL_ARGUMENT todoProducerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.