org.osid.voting

Interface BallotNotificationSession

All Superinterfaces:

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

public interface BallotNotificationSession
extends OsidSession

This session defines methods to receive notifications on adds/changes to Ballot objects in this Polls. This also includes existing ballots that may appear or disappear due to changes in the Polls 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 BallotLookupSession.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canRegisterForBallotNotifications() Tests if this user can register for Ballot notifications.
Polls	getPolls() Gets the Polls associated with this session.
Id	getPollsId() Gets the Polls Id associated with this session.
void	registerForChangedBallot(Id ballotId) Registers for notification of an updated ballot.
void	registerForChangedBallots() Registers for notification of updated ballots.
void	registerForDeletedBallot(Id ballotId) Registers for notification of a deleted ballot.
void	registerForDeletedBallots() Registers for notification of deleted ballots.
void	registerForNewBallots() Register for notifications of new ballots.
void	useFederatedPollsView() Federates the view for methods in this session.
void	useIsolatedPollsView() 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

getPollsId

Id getPollsId()

Gets the Polls Id associated with this session.

Returns:

the Polls Id associated with this session

Compliance:

mandatory - This method must be implemented.

getPolls

Polls getPolls()
               throws OperationFailedException,
                      PermissionDeniedException

Gets the Polls associated with this session.

Returns:

the Polls associated with this session

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canRegisterForBallotNotifications

boolean canRegisterForBallotNotifications()

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

useFederatedPollsView

void useFederatedPollsView()

Federates the view for methods in this session. A federated view will include ballots in polls which are children of this polls in the polls hierarchy.

Compliance:

mandatory - This method is must be implemented.

useIsolatedPollsView

void useIsolatedPollsView()

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

Compliance:

mandatory - This method is must be implemented.

registerForNewBallots

void registerForNewBallots()
                           throws OperationFailedException,
                                  PermissionDeniedException

Register for notifications of new ballots. BallotReceiver.newBallots() is invoked when a new Ballot is appears in this polls.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedBallots

void registerForChangedBallots()
                               throws OperationFailedException,
                                      PermissionDeniedException

Registers for notification of updated ballots. BallotReceiver.changedBallots() is invoked when a ballot in this polls is changed.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedBallot

void registerForChangedBallot(Id ballotId)
                              throws OperationFailedException,
                                     PermissionDeniedException

Registers for notification of an updated ballot. BallotReceiver.changedBallots() is invoked when the specified ballot in this polls is changed.

Parameters:

ballotId - the Id of the Ballot to monitor

Throws:

NullArgumentException - ballotId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedBallots

void registerForDeletedBallots()
                               throws OperationFailedException,
                                      PermissionDeniedException

Registers for notification of deleted ballots. BallotReceiver.deletedBallots() is invoked when a ballot is deleted or removed from this polls.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedBallot

void registerForDeletedBallot(Id ballotId)
                              throws OperationFailedException,
                                     PermissionDeniedException

Registers for notification of a deleted ballot. BallotReceiver.deletedBallots() is invoked when the specified ballot is deleted or removed from this polls.

Parameters:

ballotId - the Id of the Ballot to monitor

Throws:

NullArgumentException - ballotId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.