public interface BallotConstrainerPollsSession extends OsidSession
This session provides methods to retrieve BallotConstrainer
to Polls
mappings. A BallotConstrainer
may appear in multiple Polls
objects. Each polls
may have its own authorizations governing who is allowed to look at it.
This lookup session defines several views:
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupBallotConstrainerPollsMappings()
Tests if this user can perform lookups of ballot constrainer/polls
mappings.
|
IdList |
getBallotConstrainerIdsByPolls(Id pollsId)
Gets the list of
BallotConstrainerIds associated with a
Polls. |
IdList |
getBallotConstrainerIdsByPolls(IdList pollsIds)
Gets the list of
BallotConstrainer Ids corresponding to
a list of Polls. |
BallotConstrainerList |
getBallotConstrainersByPolls(Id pollsId)
Gets the list of ballot constrainer associated with a
Polls. |
BallotConstrainerList |
getBallotConstrainersByPolls(IdList pollsIds)
Gets the list of ballot constrainer corresponding to a list of
Polls. |
PollsList |
getPollsByBallotConstrainer(Id ballotConstrainerId)
Gets the
Polls mapped to a BallotConstrainer. |
IdList |
getPollsIdsByBallotConstrainer(Id ballotConstrainerId)
Gets the
Polls Ids mapped to a
BallotConstrainer. |
void |
useComparativeBallotConstrainerPollsView()
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 |
usePlenaryBallotConstrainerPollsView()
A complete view of the
BallotConstrainer and
Polls returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupBallotConstrainerPollsMappings()
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 useComparativeBallotConstrainerPollsView()
mandatory
- This method is must be implemented. void usePlenaryBallotConstrainerPollsView()
BallotConstrainer
and
Polls
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. IdList getBallotConstrainerIdsByPolls(Id pollsId) throws NotFoundException, OperationFailedException, PermissionDeniedException
BallotConstrainerIds
associated with a
Polls.
pollsId
- Id
of the Polls
Ids
NotFoundException
- pollsId
is not foundNullArgumentException
- pollsId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. BallotConstrainerList getBallotConstrainersByPolls(Id pollsId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Polls.
pollsId
- Id
of the Polls
NotFoundException
- pollsId
is not foundNullArgumentException
- pollsId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getBallotConstrainerIdsByPolls(IdList pollsIds) throws OperationFailedException, PermissionDeniedException
BallotConstrainer Ids
corresponding to
a list of Polls.
pollsIds
- list of polls Ids
Ids
NullArgumentException
- pollsIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. BallotConstrainerList getBallotConstrainersByPolls(IdList pollsIds) throws OperationFailedException, PermissionDeniedException
Polls.
pollsIds
- list of polls Ids
NullArgumentException
- pollsIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getPollsIdsByBallotConstrainer(Id ballotConstrainerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Polls
Ids
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. PollsList getPollsByBallotConstrainer(Id ballotConstrainerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Polls
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.