org.osid.checklist.mason

Interface TodoProducerNotificationSession

All Superinterfaces:

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

public interface TodoProducerNotificationSession
extends OsidSession

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.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canRegisterForTodoProducerNotifications() Tests if this user can register for TodoProducer notifications.
Checklist	getChecklist() Gets the Checklist associated with this session.
Id	getChecklistId() Gets the Checklist Id associated with this session.
void	registerForChangedTodoProducer(Id todoProducerId) Registers for notification of an updated todo producer.
void	registerForChangedTodoProducers() Registers for notification of updated todo producers.
void	registerForDeletedTodoProducer(Id todoProducerId) Registers for notification of a deleted todo producer.
void	registerForDeletedTodoProducers() Registers for notification of deleted todo producers.
void	registerForNewTodoProducers() Register for notifications of new todo producers.
void	useFederatedChecklistView() Federates the view for methods in this session.
void	useIsolatedChecklistView() Isolates the view for methods in this session.

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

getChecklistId

Id getChecklistId()

Gets the Checklist Id associated with this session.

Returns:

the Checklist Id associated with this session

Compliance:

mandatory - This method must be implemented.

getChecklist

Checklist getChecklist()
                       throws OperationFailedException,
                              PermissionDeniedException

Gets the Checklist associated with this session.

Returns:

the checklist

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canRegisterForTodoProducerNotifications

boolean canRegisterForTodoProducerNotifications()

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.

Returns:

false if notification methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useFederatedChecklistView

void useFederatedChecklistView()

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.

useIsolatedChecklistView

void useIsolatedChecklistView()

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.

registerForNewTodoProducers

void registerForNewTodoProducers()
                                 throws OperationFailedException,
                                        PermissionDeniedException

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

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedTodoProducers

void registerForChangedTodoProducers()
                                     throws OperationFailedException,
                                            PermissionDeniedException

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

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedTodoProducer

void registerForChangedTodoProducer(Id todoProducerId)
                                    throws OperationFailedException,
                                           PermissionDeniedException

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

Parameters:

todoProducerId - the Id of the TodoProducer to monitor

Throws:

NullArgumentException - todoProducerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedTodoProducers

void registerForDeletedTodoProducers()
                                     throws OperationFailedException,
                                            PermissionDeniedException

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

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedTodoProducer

void registerForDeletedTodoProducer(Id todoProducerId)
                                    throws OperationFailedException,
                                           PermissionDeniedException

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

Parameters:

todoProducerId - the Id of the TodoProducer to monitor

Throws:

NullArgumentException - todoProducerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.