public interface RacePollsSession extends OsidSession
This session provides methods to retrieve Race
to
Polls
mappings. A Race
may appear in multiple
Polls
objects. Each catalog 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 |
canLookupRacePollsMappings()
Tests if this user can perform lookups of race/polls mappings.
|
PollsList |
getPollsByRace(Id raceId)
Gets the
Polls objects mapped to a Race. |
IdList |
getPollsIdsByRace(Id raceId)
Gets the
Polls Ids mapped to a
Race. |
IdList |
getRaceIdsByPolls(Id pollsId)
Gets the list of
Race Ids associated with a
Polls. |
IdList |
getRaceIdsByPolls(IdList pollsIds)
Gets the list of
Race Ids corresponding to a list of
Polls objects. |
RaceList |
getRacesByPolls(Id pollsId)
Gets the list of
Races associated with a Polls. |
RaceList |
getRacesByPolls(IdList pollsIds)
Gets the list of
Races corresponding to a list of
Polls objects. |
void |
useComparativePollsView()
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 |
usePlenaryPollsView()
A complete view of the
Race and Polls
returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupRacePollsMappings()
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 useComparativePollsView()
mandatory
- This method is must be implemented. void usePlenaryPollsView()
Race
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 getRaceIdsByPolls(Id pollsId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Race Ids
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. RaceList getRacesByPolls(Id pollsId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Races
associated with a 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 getRaceIdsByPolls(IdList pollsIds) throws OperationFailedException, PermissionDeniedException
Race Ids
corresponding to a list of
Polls
objects.pollsIds
- list of polls Ids
Ids
NullArgumentException
- pollsIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RaceList getRacesByPolls(IdList pollsIds) throws OperationFailedException, PermissionDeniedException
Races
corresponding to a list of
Polls
objects.pollsIds
- list of polls Ids
NullArgumentException
- pollsIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getPollsIdsByRace(Id raceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Polls
Ids
mapped to a
Race.
raceId
- Id
of a Race
Ids
NotFoundException
- raceId
is not foundNullArgumentException
- raceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. PollsList getPollsByRace(Id raceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Polls
objects mapped to a Race.
raceId
- Id
of a Race
Ids
NotFoundException
- raceId
is not foundNullArgumentException
- raceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.