public interface RaceConstrainerEnablerPollsSession extends OsidSession
This session provides methods to retrieve RaceConstrainerEnabler
to Polls
mappings. a RaceConstrainerEnabler
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 |
canLookupRaceConstrainerEnablerPollsMappings()
Tests if this user can perform lookups of race constrainer
enabler/polls mappings.
|
PollsList |
getPollsByRaceConstrainerEnabler(Id raceConstrainerEnablerId)
Gets the
Polls mapped to a
RaceConstrainerEnabler. |
IdList |
getPollsIdsByRaceConstrainerEnabler(Id raceConstrainerEnablerId)
Gets the
Polls Ids mapped to a
RaceConstrainerEnabler. |
IdList |
getRaceConstrainerEnablerIdsByPolls(Id pollsId)
Gets the list of
RaceConstrainerEnablerIds associated
with a Polls. |
IdList |
getRaceConstrainerEnablerIdsByPolls(IdList pollsIds)
Gets the list of
RaceConstrainerEnabler Ids
corresponding to a list of Polls. |
RaceConstrainerEnablerList |
getRaceConstrainerEnablersByPolls(Id pollsId)
Gets the list of race constrainer enablers associated with a
Polls. |
RaceConstrainerEnablerList |
getRaceConstrainerEnablersByPolls(IdList pollsIds)
Gets the list of race constrainer enablers corresponding to a list of
Polls. |
void |
useComparativeRaceConstrainerEnablerPollsView()
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 |
usePlenaryRaceConstrainerEnablerPollsView()
A complete view of the
RaceConstrainerEnabler and
Polls returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupRaceConstrainerEnablerPollsMappings()
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 useComparativeRaceConstrainerEnablerPollsView()
mandatory
- This method is must be implemented. void usePlenaryRaceConstrainerEnablerPollsView()
RaceConstrainerEnabler
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 getRaceConstrainerEnablerIdsByPolls(Id pollsId) throws NotFoundException, OperationFailedException, PermissionDeniedException
RaceConstrainerEnablerIds
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. RaceConstrainerEnablerList getRaceConstrainerEnablersByPolls(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 getRaceConstrainerEnablerIdsByPolls(IdList pollsIds) throws OperationFailedException, PermissionDeniedException
RaceConstrainerEnabler 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. RaceConstrainerEnablerList getRaceConstrainerEnablersByPolls(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 getPollsIdsByRaceConstrainerEnabler(Id raceConstrainerEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Polls
Ids
mapped to a
RaceConstrainerEnabler.
raceConstrainerEnablerId
- Id
of a
RaceConstrainerEnabler
NotFoundException
- raceConstrainerEnablerId
is not foundNullArgumentException
- raceConstrainerEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. PollsList getPollsByRaceConstrainerEnabler(Id raceConstrainerEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Polls
mapped to a
RaceConstrainerEnabler.
raceConstrainerEnablerId
- Id
of a
RaceConstrainerEnabler
NotFoundException
- raceConstrainerEnablerId
is not foundNullArgumentException
- raceConstrainerEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.