public interface RaceConstrainerRuleLookupSession extends OsidSession
This session provides methods to retrieve RaceConstrainer
to Race
mappings. A Race
with
multiple RaceConstrainers
means any positive rule
evaluation across the constrainers result in an accessible Race.
This lookup session defines several views:
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupRaceConstrainerRules()
Tests if this user can perform lookups of race constrainer/race
mappings.
|
Polls |
getPolls()
Gets the
Polls associated with this session. |
Id |
getPollsId()
Gets the
Polls Id associated with this
session. |
IdList |
getRaceConstrainerIdsForRace(Id raceId)
Gets the
RaceConstrainer Id associated with a
Race. |
RaceConstrainerList |
getRaceConstrainersForRace(Id raceId)
Gets the
RaceConstrainer associated with a Race. |
IdList |
getRaceIdsForRaceConstrainer(Id raceConstrainerId)
Gets the
Race Ids mapped to a
RaceConstrainer. |
RaceList |
getRacesForRaceConstrainer(Id raceConstrainerId)
Gets the
Races mapped to a RaceConstrainer. |
void |
useComparativeRaceConstrainerRuleView()
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 |
useFederatedPollsView()
Federates the view for methods in this session.
|
void |
useIsolatedPollsView()
Isolates the view for methods in this session.
|
void |
usePlenaryRaceConstrainerRuleView()
A complete view of the
RaceConstrainer and Race
returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getPollsId()
Polls
Id
associated with this
session. Polls Id
associated with this sessionmandatory
- This method must be implemented. Polls getPolls() throws OperationFailedException, PermissionDeniedException
Polls
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canLookupRaceConstrainerRules()
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 useComparativeRaceConstrainerRuleView()
mandatory
- This method is must be implemented. void usePlenaryRaceConstrainerRuleView()
RaceConstrainer
and Race
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. void useFederatedPollsView()
mandatory
- This method is must be implemented. void useIsolatedPollsView()
mandatory
- This method is must be implemented. IdList getRaceConstrainerIdsForRace(Id raceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
RaceConstrainer Id
associated with a
Race.
raceId
- Id
of the Race
Ids
NotFoundException
- raceId
is not foundNullArgumentException
- raceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RaceConstrainerList getRaceConstrainersForRace(Id raceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
RaceConstrainer
associated with a Race.
raceId
- Id
of the Race
NotFoundException
- raceId
is not foundNullArgumentException
- raceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getRaceIdsForRaceConstrainer(Id raceConstrainerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Race
Ids
mapped to a
RaceConstrainer.
raceConstrainerId
- Id
of a
RaceConstrainer
Ids
NotFoundException
- raceConstrainerId
is
not foundNullArgumentException
- raceConstrainerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RaceList getRacesForRaceConstrainer(Id raceConstrainerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Races
mapped to a RaceConstrainer.
raceConstrainerId
- Id
of a
RaceConstrainer
NotFoundException
- raceConstrainerId
is
not foundNullArgumentException
- raceConstrainerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.