public interface RaceProcessorEnablerPollsSession extends OsidSession
This session provides methods to retrieve RaceProcessorEnabler
to Polls
mappings. a RaceProcessorEnabler
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 |
canLookupRaceProcessorEnablerPollsMappings()
Tests if this user can perform lookups of race processor enabler/polls
mappings.
|
PollsList |
getPollsByRaceProcessorEnabler(Id raceProcessorEnablerId)
Gets the
Polls mapped to a RaceProcessorEnabler. |
IdList |
getPollsIdsByRaceProcessorEnabler(Id raceProcessorEnablerId)
Gets the
Polls Ids mapped to a
RaceProcessorEnabler. |
IdList |
getRaceProcessorEnablerIdsByPolls(Id pollsId)
Gets the list of
RaceProcessorEnablerIds associated
with a Polls. |
IdList |
getRaceProcessorEnablerIdsByPolls(IdList pollsIds)
Gets the list of
RaceProcessorEnabler Ids corresponding
to a list of Polls. |
RaceProcessorEnablerList |
getRaceProcessorEnablersByPolls(Id pollsId)
Gets the list of race processor enablers associated with a
Polls. |
RaceProcessorEnablerList |
getRaceProcessorEnablersByPolls(IdList pollsIds)
Gets the list of race processor enablers corresponding to a list of
Polls. |
void |
useComparativeRaceProcessorEnablerPollsView()
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 |
usePlenaryRaceProcessorEnablerPollsView()
A complete view of the
RaceProcessorEnabler and
Polls returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupRaceProcessorEnablerPollsMappings()
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 useComparativeRaceProcessorEnablerPollsView()
mandatory
- This method is must be implemented. void usePlenaryRaceProcessorEnablerPollsView()
RaceProcessorEnabler
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 getRaceProcessorEnablerIdsByPolls(Id pollsId) throws NotFoundException, OperationFailedException, PermissionDeniedException
RaceProcessorEnablerIds
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. RaceProcessorEnablerList getRaceProcessorEnablersByPolls(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 getRaceProcessorEnablerIdsByPolls(IdList pollsIds) throws OperationFailedException, PermissionDeniedException
RaceProcessorEnabler 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. RaceProcessorEnablerList getRaceProcessorEnablersByPolls(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 getPollsIdsByRaceProcessorEnabler(Id raceProcessorEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Polls
Ids
mapped to a
RaceProcessorEnabler.
raceProcessorEnablerId
- Id
of a
RaceProcessorEnabler
NotFoundException
- raceProcessorEnablerId
is not foundNullArgumentException
- raceProcessorEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. PollsList getPollsByRaceProcessorEnabler(Id raceProcessorEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Polls
mapped to a RaceProcessorEnabler.
raceProcessorEnablerId
- Id
of a
RaceProcessorEnabler
NotFoundException
- raceProcessorEnablerId
is not foundNullArgumentException
- raceProcessorEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.