public interface BallotConstrainerNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to BallotConstrainer
objects in this Polls.
This also includes existing BallotConstrainers
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
BallotConstrainerLookupSession.
Modifier and Type | Method and Description |
---|---|
void |
acknowledgeBallotConstrainerNotification(Id notificationId)
Acknowledge a ballot constrainer notification.
|
boolean |
canRegisterForBallotConstrainerNotifications()
Tests if this user can register for
BallotConstrainer
notifications. |
Polls |
getPolls()
Gets the
Polls associated with this session. |
Id |
getPollsId()
Gets the
Polls Id associated with this
session. |
void |
registerForChangedBallotConstrainer(Id ballotConstrainerId)
Registers for notification of an updated ballot constrainer.
|
void |
registerForChangedBallotConstrainers()
Registers for notification of updated polls.
|
void |
registerForDeletedBallotConstrainer(Id ballotConstrainerId)
Registers for notification of a deleted ballot constrainer.
|
void |
registerForDeletedBallotConstrainers()
Registers for notification of deleted ballot constrainers.
|
void |
registerForNewBallotConstrainers()
Register for notifications of new ballot constrainers.
|
void |
reliableBallotConstrainerNotifications()
Reliable notifications are desired.
|
void |
unreliableBallotConstrainerNotifications()
Unreliable notifications are desired.
|
void |
useFederatedPollsView()
Federates the view for methods in this session.
|
void |
useIsolatedPollsView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getPollsId()
Polls
Id
associated with this
session. Polls Id
associated with this sessionmandatory
- This method must be implemented. Polls getPolls() throws OperationFailedException, PermissionDeniedException
Polls
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canRegisterForBallotConstrainerNotifications()
BallotConstrainer
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. false
if notification methods are not
authorized, true
otherwisemandatory
- This method must be implemented. void useFederatedPollsView()
mandatory
- This method is must be implemented. void useIsolatedPollsView()
mandatory
- This method is must be implemented. void reliableBallotConstrainerNotifications()
acknowledgeBallotConstrainerNotification()
.mandatory
- This method is must be implemented. void unreliableBallotConstrainerNotifications()
mandatory
- This method is must be implemented. void acknowledgeBallotConstrainerNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
notificationId
- the Id
of the notificationOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewBallotConstrainers() throws OperationFailedException, PermissionDeniedException
BallotConstrainerReceiver.newBallotConstrainers()
is invoked
when a new BallotConstrainer
appears in this polls.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedBallotConstrainers() throws OperationFailedException, PermissionDeniedException
BallotConstrainerReceiver.changedBallotConstrainers()
is
invoked when a ballot constrainer in this polls is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedBallotConstrainer(Id ballotConstrainerId) throws OperationFailedException, PermissionDeniedException
ProvisionableReceiver.changedBallotConstrainers()
is invoked
when the specified ballot constrainer in this polls is changed.ballotConstrainerId
- the Id
of the
BallotConstrainer
to monitorNullArgumentException
- ballotConstrainerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedBallotConstrainers() throws OperationFailedException, PermissionDeniedException
BallotConstrainerReceiver.deletedBallotConstrainers()
is
invoked when a ballot constrainer is deleted or removed from this
polls.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedBallotConstrainer(Id ballotConstrainerId) throws OperationFailedException, PermissionDeniedException
BallotConstrainerReceiver.deletedBallotConstrainers()
is
invoked when the specified ballot constrainer is deleted or removed
from this polls.ballotConstrainerId
- the Id
of the
BallotConstrainer
to monitorNullArgumentException
- ballotConstrainerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.