public interface RaceProcessorPollsSession extends OsidSession
This session provides methods to retrieve RaceProcessor
to Polls
mappings. a RaceProcessor
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 |
canLookupRaceProcessorPollsMappings()
Tests if this user can perform lookups of race processor/polls
mappings.
|
PollsList |
getPollsByRaceProcessor(Id raceProcessorId)
Gets the
Polls mapped to a RaceProcessor. |
IdList |
getPollsIdsByRaceProcessor(Id raceProcessorId)
Gets the
Polls Ids mapped to a
RaceProcessor. |
IdList |
getRaceProcessorIdsByPolls(Id pollsId)
Gets the list of
RaceProcessorIds associated with a
Polls. |
IdList |
getRaceProcessorIdsByPolls(IdList pollsIds)
Gets the list of
RaceProcessor Ids corresponding to a
list of Polls. |
RaceProcessorList |
getRaceProcessorsByPolls(Id pollsId)
Gets the list of race processors associated with a
Polls. |
RaceProcessorList |
getRaceProcessorsByPolls(IdList pollsIds)
Gets the list of race processor corresponding to a list of
Polls. |
void |
useComparativeRaceProcessorPollsView()
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 |
usePlenaryRaceProcessorPollsView()
A complete view of the
RaceProcessor and Polls
returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupRaceProcessorPollsMappings()
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 useComparativeRaceProcessorPollsView()
mandatory
- This method is must be implemented. void usePlenaryRaceProcessorPollsView()
RaceProcessor
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 getRaceProcessorIdsByPolls(Id pollsId) throws NotFoundException, OperationFailedException, PermissionDeniedException
RaceProcessorIds
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. RaceProcessorList getRaceProcessorsByPolls(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 getRaceProcessorIdsByPolls(IdList pollsIds) throws OperationFailedException, PermissionDeniedException
RaceProcessor 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. RaceProcessorList getRaceProcessorsByPolls(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 getPollsIdsByRaceProcessor(Id raceProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Polls
Ids
mapped to a
RaceProcessor.
raceProcessorId
- Id
of a RaceProcessor
NotFoundException
- raceProcessorId
is
not foundNullArgumentException
- raceProcessorId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. PollsList getPollsByRaceProcessor(Id raceProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Polls
mapped to a RaceProcessor.
raceProcessorId
- Id
of a RaceProcessor
NotFoundException
- raceProcessorId
is
not foundNullArgumentException
- raceProcessorId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.