org.osid.voting

Interface PollsNotificationSession

All Superinterfaces:

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

public interface PollsNotificationSession
extends OsidSession

This session defines methods to receive notifications on adds/changes to Polls 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.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canRegisterForPollsNotifications() Tests if this user can register for Polls notifications.
void	registerForChangedPolls() Registers for notification of updated polls.
void	registerForChangedPolls(Id pollsId) Registers for notification of an updated polls.
void	registerForDeletedPolls() Registers for notification of deleted polls.
void	registerForDeletedPolls(Id pollsId) Registers for notification of a deleted polls.
void	registerForDeletedPollsAncestors(Id pollsId) Registers for notification if an ancestor is removed from the specified polls in the polls hierarchy.
void	registerForDeletedPollsDescendants(Id pollsId) Registers for notification if a descendant is removed from fthe specified polls in the polls hierarchy.
void	registerForNewPolls() Register for notifications of new polls.
void	registerForNewPollsAncestors(Id pollsId) Registers for notification if an ancestor is added to the specified polls in the polls hierarchy.
void	registerForNewPollsDescendants(Id pollsId) Registers for notification if a descendant is added to the specified polls in the polls hierarchy.

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

canRegisterForPollsNotifications

boolean canRegisterForPollsNotifications()

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

registerForNewPolls

void registerForNewPolls()
                         throws OperationFailedException,
                                PermissionDeniedException

Register for notifications of new polls. PollsReceiver.newPolls() is invoked when a new Polls is created.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForNewPollsAncestors

void registerForNewPollsAncestors(Id pollsId)
                                  throws OperationFailedException,
                                         PermissionDeniedException

Registers for notification if an ancestor is added to the specified polls in the polls hierarchy. PollsReceiver.newPollsAncestor() is invoked when the specified polls experiences an addition in ancestry.

Parameters:

pollsId - the Id of the polls to monitor

Throws:

NullArgumentException - pollsId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForNewPollsDescendants

void registerForNewPollsDescendants(Id pollsId)
                                    throws OperationFailedException,
                                           PermissionDeniedException

Registers for notification if a descendant is added to the specified polls in the polls hierarchy. PollsReceiver.newPollsDescendant() is invoked when the specified polls experiences an addition in descendants.

Parameters:

pollsId - the Id of the polls to monitor

Throws:

NullArgumentException - pollsId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedPolls

void registerForChangedPolls()
                             throws OperationFailedException,
                                    PermissionDeniedException

Registers for notification of updated polls. PollsReceiver.changedPolls() is invoked when a polls is changed.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedPolls

void registerForChangedPolls(Id pollsId)
                             throws OperationFailedException,
                                    PermissionDeniedException

Registers for notification of an updated polls. PollsReceiver.changedPolls() is invoked when the specified polls is changed.

Parameters:

pollsId - the Id of the Polls to monitor

Throws:

NullArgumentException - pollsId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedPolls

void registerForDeletedPolls()
                             throws OperationFailedException,
                                    PermissionDeniedException

Registers for notification of deleted polls. PollsReceiver.deletedPolls() is invoked when a polls is deleted.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedPolls

void registerForDeletedPolls(Id pollsId)
                             throws OperationFailedException,
                                    PermissionDeniedException

Registers for notification of a deleted polls. PollsReceiver.deletedPolls() is invoked when the specified polls is deleted.

Parameters:

pollsId - the Id of the Polls to monitor

Throws:

NullArgumentException - pollsId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedPollsAncestors

void registerForDeletedPollsAncestors(Id pollsId)
                                      throws OperationFailedException,
                                             PermissionDeniedException

Registers for notification if an ancestor is removed from the specified polls in the polls hierarchy. PollsReceiver.deletedPollsAncestor() is invoked when the specified polls experiences a removal of an ancestor.

Parameters:

pollsId - the Id of the polls to monitor

Throws:

NullArgumentException - pollsId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedPollsDescendants

void registerForDeletedPollsDescendants(Id pollsId)
                                        throws OperationFailedException,
                                               PermissionDeniedException

Registers for notification if a descendant is removed from fthe specified polls in the polls hierarchy. PollsReceiver.deletedPollsDescendnant() is invoked when the specified polls experiences a removal of one of its descdendents.

Parameters:

pollsId - the Id of the polls to monitor

Throws:

NullArgumentException - pollsId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.