public interface BallotConstrainerEnablerNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to BallotConstrainerEnabler
objects in this Polls.
This also includes existing BallotConstrainerEnablers
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
BallotConstrainerEnablerLookupSession.
Modifier and Type | Method and Description |
---|---|
void |
acknowledgeBallotConstrainerEnablerNotification(Id notificationId)
Acknowledge a ballot constrainer enabler notification.
|
boolean |
canRegisterForBallotConstrainerEnablerNotifications()
Tests if this user can register for
BallotConstrainerEnabler
notifications. |
Polls |
getPolls()
Gets the
Polls associated with this session. |
Id |
getPollsId()
Gets the
Polls Id associated with this
session. |
void |
registerForChangedBallotConstrainerEnabler(Id ballotConstrainerEnablerId)
Registers for notification of an updated ballot constrainer enabler.
|
void |
registerForChangedBallotConstrainerEnablers()
Registers for notification of updated polls enabelrs.
|
void |
registerForDeletedBallotConstrainerEnabler(Id ballotConstrainerEnablerId)
Registers for notification of a deleted ballot constrainer enabler.
|
void |
registerForDeletedBallotConstrainerEnablers()
Registers for notification of deleted ballot constrainer enablers.
|
void |
registerForNewBallotConstrainerEnablers()
Register for notifications of new ballot constrainer enablers.
|
void |
reliableBallotConstrainerEnablerNotifications()
Reliable notifications are desired.
|
void |
unreliableBallotConstrainerEnablerNotifications()
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 canRegisterForBallotConstrainerEnablerNotifications()
BallotConstrainerEnabler
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 reliableBallotConstrainerEnablerNotifications()
acknowledgeBallotConstrainerEnablerNotification()
.mandatory
- This method is must be implemented. void unreliableBallotConstrainerEnablerNotifications()
mandatory
- This method is must be implemented. void acknowledgeBallotConstrainerEnablerNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
notificationId
- the Id
of the notificationOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewBallotConstrainerEnablers() throws OperationFailedException, PermissionDeniedException
BallotConstrainerEnablerReceiver.newBallotConstrainerEnablers()
is invoked when a new BallotConstrainerEnabler
appears in this polls.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedBallotConstrainerEnablers() throws OperationFailedException, PermissionDeniedException
BallotConstrainerEnablerReceiver.changedBallotConstrainerEnablers()
is invoked when a ballot constrainer enabler in this polls is
changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedBallotConstrainerEnabler(Id ballotConstrainerEnablerId) throws OperationFailedException, PermissionDeniedException
ProvisionableReceiver.changedBallotConstrainerEnablers()
is invoked when the specified ballot constrainer enabler in
this polls is changed.ballotConstrainerEnablerId
- the Id
of the
BallotConstrainerEnabler
to monitorNullArgumentException
-
ballotConstrainerEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedBallotConstrainerEnablers() throws OperationFailedException, PermissionDeniedException
BallotConstrainerEnablerReceiver.deletedBallotConstrainerEnablers()
is invoked when a ballot constrainer enabler is deleted or
removed from this polls.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedBallotConstrainerEnabler(Id ballotConstrainerEnablerId) throws OperationFailedException, PermissionDeniedException
BallotConstrainerEnablerReceiver.deletedBallotConstrainerEnablers()
is invoked when the specified ballot constrainer enabler is
deleted or removed from this polls.ballotConstrainerEnablerId
- the Id
of the
BallotConstrainerEnabler
to monitorNullArgumentException
-
ballotConstrainerEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.