public interface RaceProcessorLookupSession extends OsidSession
This session provides methods for retrieving RaceProcessors.
This session defines views that offer differing behaviors when retrieving multiple objects.
RaceProcessors
with the
RaceProcessorAdminSession.
Generally, the comparative view should be used for most applications
as it permits operation even if there is data that cannot be accessed. The
methods useFederatedPollsView()
and
useIsolatedPollsView()
behave as a radio group and one should be
selected before invoking the methods in this session.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupRaceProcessors()
Tests if this user can perform
RaceProcessors lookups. |
Polls |
getPolls()
Gets the
Polls associated with this session. |
Id |
getPollsId()
Gets the
Polls Id associated with this
session. |
RaceProcessor |
getRaceProcessor(Id raceProcessorId)
Gets the
RaceProcessor specified by its Id. |
RaceProcessorList |
getRaceProcessors()
Gets all
RaceProcessors. |
RaceProcessorList |
getRaceProcessorsByGenusType(Type raceProcessorGenusType)
Gets a
RaceProcessorList corresponding to the given
race processor genus Type which does not include race
processor of genus types derived from the specified Type. |
RaceProcessorList |
getRaceProcessorsByIds(IdList raceProcessorIds)
Gets a
RaceProcessorList corresponding to the given
IdList. |
RaceProcessorList |
getRaceProcessorsByParentGenusType(Type raceProcessorGenusType)
Gets a
RaceProcessorList corresponding to the given
race processor genus Type and include any additional
race processor with genus types derived from the specified
Type. |
RaceProcessorList |
getRaceProcessorsByRecordType(Type raceProcessorRecordType)
Gets a
RaceProcessorList containing the given race
processor record Type. |
void |
useActiveRaceProcessorView()
Only active race processors are returned by methods in this session.
|
void |
useAnyStatusRaceProcessorView()
All active and inactive race processors are returned by methods in
this session.
|
void |
useComparativeRaceProcessorView()
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 |
usePlenaryRaceProcessorView()
A complete view of the
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 canLookupRaceProcessors()
RaceProcessors
lookups.
A return of true does not guarantee successful authorization. A return
of false indicates that it is known all methods in this session will
result in a PERMISSION_DENIED.
This is intended as a
hint to an application that may opt not to offer lookup operations to
unauthorized users. false
if lookup methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeRaceProcessorView()
mandatory
- This method is must be implemented. void usePlenaryRaceProcessorView()
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. void useActiveRaceProcessorView()
mandatory
- This method is must be implemented. void useAnyStatusRaceProcessorView()
mandatory
- This method is must be implemented. RaceProcessor getRaceProcessor(Id raceProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
RaceProcessor
specified by its Id.
In plenary mode, the exact Id
is found
or a NOT_FOUND
results. Otherwise, the returned
RaceProcessor
may have a different Id
than
requested, such as the case where a duplicate Id
was
assigned to a RaceProcessor
and retained for
compatibility.
In active mode, race processors are returned that are currently
active. In any status mode, active and inactive race processors are
returned.raceProcessorId
- Id
of the RaceProcessor
NotFoundException
- raceProcessorId
not
foundNullArgumentException
- raceProcessorId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. RaceProcessorList getRaceProcessorsByIds(IdList raceProcessorIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
RaceProcessorList
corresponding to the given
IdList.
In plenary mode, the returned list contains all of the
race processor specified in the Id
list, in the order
of the list, including duplicates, or an error results if a Id
in the supplied list is not found or inaccessible. Otherwise,
inaccessible RaceProcessors
may be omitted from the
list and may present the elements in any order including returning a
unique set.
In active mode, race processors are returned that are currently
active. In any status mode, active and inactive race processors are
returned.raceProcessorIds
- the list of Ids
to retrieve RaceProcessor
listNotFoundException
- a Id
was not foundNullArgumentException
- raceProcessorIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RaceProcessorList getRaceProcessorsByGenusType(Type raceProcessorGenusType) throws OperationFailedException, PermissionDeniedException
RaceProcessorList
corresponding to the given
race processor genus Type
which does not include race
processor of genus types derived from the specified Type.
In plenary mode, the returned list contains all known
race processor or an error results. Otherwise, the returned list may
contain only those race processor that are accessible through this
session.
In active mode, race processors are returned that are currently
active. In any status mode, active and inactive race processors are
returned.raceProcessorGenusType
- a race processor genus type RaceProcessor
listNullArgumentException
- raceProcessorGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RaceProcessorList getRaceProcessorsByParentGenusType(Type raceProcessorGenusType) throws OperationFailedException, PermissionDeniedException
RaceProcessorList
corresponding to the given
race processor genus Type
and include any additional
race processor with genus types derived from the specified
Type.
In plenary mode, the returned list contains all known
race processor or an error results. Otherwise, the returned list may
contain only those race processor that are accessible through this
session.
In active mode, race processors are returned that are currently
active. In any status mode, active and inactive race processors are
returned.raceProcessorGenusType
- a race processor genus type RaceProcessor
listNullArgumentException
- raceProcessorGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RaceProcessorList getRaceProcessorsByRecordType(Type raceProcessorRecordType) throws OperationFailedException, PermissionDeniedException
RaceProcessorList
containing the given race
processor record Type.
In plenary mode, the returned list contains all known
race processor or an error results. Otherwise, the returned list may
contain only those race processor that are accessible through this
session.
In active mode, race processors are returned that are currently
active. In any status mode, active and inactive race processors are
returned.raceProcessorRecordType
- a race processor record type RaceProcessor
listNullArgumentException
- raceProcessorRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RaceProcessorList getRaceProcessors() throws OperationFailedException, PermissionDeniedException
RaceProcessors.
In plenary mode, the returned list contains all known race processor
or an error results. Otherwise, the returned list may contain only
those race processor that are accessible through this session.
In active mode, race processors are returned that are currently
active. In any status mode, active and inactive race processors are
returned. RaceProcessor
listOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.