public interface BallotConstrainerEnablerPollsSession extends OsidSession
This session provides methods to retrieve
BallotConstrainerEnabler
to Polls
mappings. A
BallotConstrainerEnabler
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 |
canLookupBallotConstrainerEnablerPollsMappings()
Tests if this user can perform lookups of ballot constrainer
enabler/polls mappings.
|
IdList |
getBallotConstrainerEnablerIdsByPolls(Id pollsId)
Gets the list of
BallotConstrainerEnablerIds associated
with a Polls. |
IdList |
getBallotConstrainerEnablerIdsByPolls(IdList pollsIds)
Gets the list of
BallotConstrainerEnabler Ids
corresponding to a list of Polls. |
BallotConstrainerEnablerList |
getBallotConstrainerEnablersByPolls(Id pollsId)
Gets the list of ballot constrainer enablers associated with a
Polls. |
BallotConstrainerEnablerList |
getBallotConstrainerEnablersByPolls(IdList pollsIds)
Gets the list of ballot constrainer enablers corresponding to a list
of
Polls. |
PollsList |
getPollsByBallotConstrainerEnabler(Id ballotConstrainerEnablerId)
Gets the
Polls mapped to a
BallotConstrainerEnabler. |
IdList |
getPollsIdsByBallotConstrainerEnabler(Id ballotConstrainerEnablerId)
Gets the
Polls Ids mapped to a
BallotConstrainerEnabler. |
void |
useComparativeBallotConstrainerEnablerPollsView()
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 |
usePlenaryBallotConstrainerEnablerPollsView()
A complete view of the
BallotConstrainerEnabler and
Polls returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupBallotConstrainerEnablerPollsMappings()
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 useComparativeBallotConstrainerEnablerPollsView()
mandatory
- This method is must be implemented. void usePlenaryBallotConstrainerEnablerPollsView()
BallotConstrainerEnabler
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 getBallotConstrainerEnablerIdsByPolls(Id pollsId) throws NotFoundException, OperationFailedException, PermissionDeniedException
BallotConstrainerEnablerIds
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. BallotConstrainerEnablerList getBallotConstrainerEnablersByPolls(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 getBallotConstrainerEnablerIdsByPolls(IdList pollsIds) throws OperationFailedException, PermissionDeniedException
BallotConstrainerEnabler 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. BallotConstrainerEnablerList getBallotConstrainerEnablersByPolls(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 getPollsIdsByBallotConstrainerEnabler(Id ballotConstrainerEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Polls
Ids
mapped to a
BallotConstrainerEnabler.
ballotConstrainerEnablerId
- Id
of a
BallotConstrainerEnabler
NotFoundException
- ballotConstrainerEnablerId
is not foundNullArgumentException
-
ballotConstrainerEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. PollsList getPollsByBallotConstrainerEnabler(Id ballotConstrainerEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Polls
mapped to a
BallotConstrainerEnabler.
ballotConstrainerEnablerId
- Id
of a
BallotConstrainerEnabler
NotFoundException
- ballotConstrainerEnablerId
is not foundNullArgumentException
-
ballotConstrainerEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.