public interface RaceProcessorEnablerRuleLookupSession extends OsidSession
This session provides methods to retrieve RaceProcessorEnabler
to RaceProcessor
mappings. a RaceProcessor
with multiple RaceProcessorEnablers
means any
positive rule evaluation across the enablers result in an effective
RaceProcessor.
This lookup session defines several views:
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupRaceProcessorEnablerRules()
Tests if this user can perform lookups of race processor enabler/race
processor mappings.
|
Polls |
getPolls()
Gets the
Polls associated with this session. |
Id |
getPollsId()
Gets the
Polls Id associated with this
session. |
IdList |
getRaceProcessorEnablerIdsForRaceProcessor(Id raceProcessorId)
Gets the
RaceProcessorEnabler Id associated with a
RaceProcessor. |
RaceProcessorEnablerList |
getRaceProcessorEnablersForRaceProcessor(Id raceProcessorId)
Gets the
RaceProcessorEnabler associated with a
RaceProcessor. |
IdList |
getRaceProcessorIdsForRaceProcessorEnabler(Id raceProcessorEnablerId)
Gets the
RaceProcessor Ids mapped to a
RaceProcessorEnabler. |
RaceProcessorList |
getRaceProcessorsForRaceProcessorEnabler(Id raceProcessorEnablerId)
Gets the
RaceProcessors mapped to a
RaceProcessorEnabler. |
void |
useComparativeRaceProcessorEnablerRuleView()
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 |
usePlenaryRaceProcessorEnablerRuleView()
A complete view of the
RaceProcessorEnabler and
RaceProcessor 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 canLookupRaceProcessorEnablerRules()
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 useComparativeRaceProcessorEnablerRuleView()
mandatory
- This method is must be implemented. void usePlenaryRaceProcessorEnablerRuleView()
RaceProcessorEnabler
and
RaceProcessor
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 getRaceProcessorEnablerIdsForRaceProcessor(Id raceProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
RaceProcessorEnabler Id
associated with a
RaceProcessor.
raceProcessorId
- Id
of the RaceProcessor
Ids
NotFoundException
- raceProcessorId
is
not foundNullArgumentException
- raceProcessorId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RaceProcessorEnablerList getRaceProcessorEnablersForRaceProcessor(Id raceProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
RaceProcessorEnabler
associated with a
RaceProcessor.
raceProcessorId
- Id
of the RaceProcessor
NotFoundException
- raceProcessorId
is
not foundNullArgumentException
- raceProcessorId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getRaceProcessorIdsForRaceProcessorEnabler(Id raceProcessorEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
RaceProcessor
Ids
mapped to a
RaceProcessorEnabler.
raceProcessorEnablerId
- Id
of a
RaceProcessorEnabler
Ids
NotFoundException
- raceProcessorEnablerId
is not foundNullArgumentException
- raceProcessorEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RaceProcessorList getRaceProcessorsForRaceProcessorEnabler(Id raceProcessorEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
RaceProcessors
mapped to a
RaceProcessorEnabler.
raceProcessorEnablerId
- Id
of a
RaceProcessorEnabler
NotFoundException
- raceProcessorEnablerId
is not foundNullArgumentException
- raceProcessorEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.