public interface BallotConstrainerRuleLookupSession extends OsidSession
This session provides methods to retrieve BallotConstrainer
to Ballot
mappings. A Ballot
with
multiple BallotConstrainers
means any positive rule
evaluation across the constrainers result in an accessible Ballot.
This lookup session defines several views:
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupBallotConstrainerRules()
Tests if this user can perform lookups of ballot constrainer/ballot
mappings.
|
IdList |
getBallotConstrainerIdsForBallot(Id ballotId)
Gets the
BallotConstrainer Id associated with a
Ballot. |
BallotConstrainerList |
getBallotConstrainersForBallot(Id ballotId)
Gets the
BallotConstrainer associated with a
Ballot. |
IdList |
getBallotIdsForBallotConstrainer(Id ballotConstrainerId)
Gets the
Ballot Ids mapped to a
BallotConstrainer. |
BallotList |
getBallotsForBallotConstrainer(Id ballotConstrainerId)
Gets the
Ballots mapped to a BallotConstrainer. |
Polls |
getPolls()
Gets the
Polls associated with this session. |
Id |
getPollsId()
Gets the
Polls Id associated with this
session. |
void |
useComparativeBallotConstrainerRuleView()
The returns from the lookup methods may omit or translate elements
based on this session, such as authorization, and not result in an
error.
|
void |
useFederatedPollsView()
Federates the view for methods in this session.
|
void |
useIsolatedPollsView()
Isolates the view for methods in this session.
|
void |
usePlenaryBallotConstrainerRuleView()
A complete view of the
BallotConstrainer and
Ballot returns is desired. |
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 canLookupBallotConstrainerRules()
PERMISSION_DENIED.
This is intended as a hint to an application that may opt not
to offer lookup operations to unauthorized users. false
if looking up mappings is not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeBallotConstrainerRuleView()
mandatory
- This method is must be implemented. void usePlenaryBallotConstrainerRuleView()
BallotConstrainer
and
Ballot
returns is desired. Methods will return what is
requested or result in an error. This view is used when greater
precision is desired at the expense of interoperability.mandatory
- This method is must be implemented. void useFederatedPollsView()
mandatory
- This method is must be implemented. void useIsolatedPollsView()
mandatory
- This method is must be implemented. IdList getBallotConstrainerIdsForBallot(Id ballotId) throws NotFoundException, OperationFailedException, PermissionDeniedException
BallotConstrainer Id
associated with a
Ballot.
ballotId
- Id
of the Ballot
Ids
NotFoundException
- ballotId
is not
foundNullArgumentException
- ballotId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. BallotConstrainerList getBallotConstrainersForBallot(Id ballotId) throws NotFoundException, OperationFailedException, PermissionDeniedException
BallotConstrainer
associated with a
Ballot.
ballotId
- Id
of the Ballot
NotFoundException
- ballotId
is not
foundNullArgumentException
- ballotId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getBallotIdsForBallotConstrainer(Id ballotConstrainerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Ballot
Ids
mapped to a
BallotConstrainer.
ballotConstrainerId
- Id
of a
BallotConstrainer
Ids
NotFoundException
- ballotConstrainerId
is not foundNullArgumentException
- ballotConstrainerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. BallotList getBallotsForBallotConstrainer(Id ballotConstrainerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Ballots
mapped to a BallotConstrainer.
ballotConstrainerId
- Id
of a
BallotConstrainer
NotFoundException
- ballotConstrainerId
is not foundNullArgumentException
- ballotConstrainerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.