public interface RaceConstrainerEnablerRuleLookupSession extends OsidSession
This session provides methods to retrieve RaceConstrainerEnabler
to RaceConstrainer
mappings. a Race
with multiple RaceConstrainerEnablers
means any positive
rule evaluation across the enablers result in an effective
RaceConstrainer.
This lookup session defines several views:
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupRaceConstrainerEnablerRules()
Tests if this user can perform lookups of race constrainer
enabler/race constrainer mappings.
|
Polls |
getPolls()
Gets the
Polls associated with this session. |
Id |
getPollsId()
Gets the
Polls Id associated with this
session. |
IdList |
getRaceConstrainerEnablerIdsForRaceConstrainer(Id raceConstrainerId)
Gets the
RaceConstrainerEnabler Id associated with a
RaceConstrainer. |
RaceConstrainerEnablerList |
getRaceConstrainerEnablersForRaceConstrainer(Id raceConstrainerId)
Gets the
RaceConstrainerEnablers associated with a
RaceConstrainer. |
IdList |
getRaceConstrainerIdsForRaceConstrainerEnabler(Id raceConstrainerEnablerId)
Gets the
RaceConstrainer Ids mapped to a
RaceConstrainerEnabler. |
RaceConstrainerList |
getRaceConstrainersForRaceConstrainerEnabler(Id raceConstrainerEnablerId)
Gets the
RaceConstrainers mapped to a
RaceConstrainerEnabler. |
void |
useComparativeRaceConstrainerEnablerRuleView()
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 |
usePlenaryRaceConstrainerEnablerRuleView()
A complete view of the
RaceConstrainerEnabler and
RaceConstrainer 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 canLookupRaceConstrainerEnablerRules()
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 useComparativeRaceConstrainerEnablerRuleView()
mandatory
- This method is must be implemented. void usePlenaryRaceConstrainerEnablerRuleView()
RaceConstrainerEnabler
and
RaceConstrainer
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 getRaceConstrainerEnablerIdsForRaceConstrainer(Id raceConstrainerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
RaceConstrainerEnabler Id
associated with a
RaceConstrainer.
raceConstrainerId
- Id
of the
RaceConstrainer
Ids
NotFoundException
- raceConstrainerId
is
not foundNullArgumentException
- raceConstrainerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RaceConstrainerEnablerList getRaceConstrainerEnablersForRaceConstrainer(Id raceConstrainerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
RaceConstrainerEnablers
associated with a
RaceConstrainer.
raceConstrainerId
- Id
of the
RaceConstrainer
NotFoundException
- raceConstrainerId
is
not foundNullArgumentException
- raceConstrainerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getRaceConstrainerIdsForRaceConstrainerEnabler(Id raceConstrainerEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
RaceConstrainer
Ids
mapped to a
RaceConstrainerEnabler.
raceConstrainerEnablerId
- Id
of a
RaceConstrainerEnabler
Ids
NotFoundException
- raceConstrainerEnablerId
is not foundNullArgumentException
- raceConstrainerEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RaceConstrainerList getRaceConstrainersForRaceConstrainerEnabler(Id raceConstrainerEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
RaceConstrainers
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.