public interface RaceConstrainerLookupSession extends OsidSession
This session provides methods for retrieving RaceConstrainers.
This session defines views that offer differing behaviors when retrieving multiple objects.
RaceConstrainers
with the
RaceConstrainerAdminSession.
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 |
canLookupRaceConstrainers()
Tests if this user can perform
RaceConstrainers
lookups. |
Polls |
getPolls()
Gets the
Polls associated with this session. |
Id |
getPollsId()
Gets the
Polls Id associated with this
session. |
RaceConstrainer |
getRaceConstrainer(Id raceConstrainerId)
Gets the
RaceConstrainer specified by its Id. |
RaceConstrainerList |
getRaceConstrainers()
Gets all
RaceConstrainers. |
RaceConstrainerList |
getRaceConstrainersByGenusType(Type raceConstrainerGenusType)
Gets a
RaceConstrainerList corresponding to the given
race constrainer genus Type which does not include race
constrainer of genus types derived from the specified Type. |
RaceConstrainerList |
getRaceConstrainersByIds(IdList raceConstrainerIds)
Gets a
RaceConstrainerList corresponding to the given
IdList. |
RaceConstrainerList |
getRaceConstrainersByParentGenusType(Type raceConstrainerGenusType)
Gets a
RaceConstrainerList corresponding to the given
race constrainer genus Type and include any additional
race constrainer with genus types derived from the specified
Type. |
RaceConstrainerList |
getRaceConstrainersByRecordType(Type raceConstrainerRecordType)
Gets a
RaceConstrainerList containing the given race
constrainer record Type. |
void |
useActiveRaceConstrainerView()
Only active race constrainer are returned by methods in this session.
|
void |
useAnyStatusRaceConstrainerView()
All active and inactive race constrainers are returned by methods in
this session.
|
void |
useComparativeRaceConstrainerView()
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 |
usePlenaryRaceConstrainerView()
A complete view of the
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 canLookupRaceConstrainers()
RaceConstrainers
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 useComparativeRaceConstrainerView()
mandatory
- This method is must be implemented. void usePlenaryRaceConstrainerView()
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. void useActiveRaceConstrainerView()
mandatory
- This method is must be implemented. void useAnyStatusRaceConstrainerView()
mandatory
- This method is must be implemented. RaceConstrainer getRaceConstrainer(Id raceConstrainerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
RaceConstrainer
specified by its Id.
In plenary mode, the exact Id
is found
or a NOT_FOUND
results. Otherwise, the returned
RaceConstrainer
may have a different Id
than
requested, such as the case where a duplicate Id
was
assigned to a RaceConstrainer
and retained for
compatibility.
In active mode, race constrainers are returned that are currently
active. In any status mode, active and inactive race constrainer are
returned.raceConstrainerId
- Id
of the
RaceConstrainer
NotFoundException
- raceConstrainerId
not foundNullArgumentException
- raceConstrainerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. RaceConstrainerList getRaceConstrainersByIds(IdList raceConstrainerIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
RaceConstrainerList
corresponding to the given
IdList.
In plenary mode, the returned list contains all of the
race constrainer 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 RaceConstrainers
may be omitted from the
list and may present the elements in any order including returning a
unique set.
In active mode, race constrainers are returned that are currently
active. In any status mode, active and inactive race constrainer are
returned.raceConstrainerIds
- the list of Ids
to retrieve RaceConstrainer
listNotFoundException
- a Id
was not foundNullArgumentException
- raceConstrainerIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RaceConstrainerList getRaceConstrainersByGenusType(Type raceConstrainerGenusType) throws OperationFailedException, PermissionDeniedException
RaceConstrainerList
corresponding to the given
race constrainer genus Type
which does not include race
constrainer of genus types derived from the specified Type.
In plenary mode, the returned list contains all known
race constrainer or an error results. Otherwise, the returned list may
contain only those race constrainer that are accessible through this
session.
In active mode, race constrainers are returned that are currently
active. In any status mode, active and inactive race constrainer are
returned.raceConstrainerGenusType
- a race constrainer genus type RaceConstrainer
listNullArgumentException
- raceConstrainerGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RaceConstrainerList getRaceConstrainersByParentGenusType(Type raceConstrainerGenusType) throws OperationFailedException, PermissionDeniedException
RaceConstrainerList
corresponding to the given
race constrainer genus Type
and include any additional
race constrainer with genus types derived from the specified
Type.
In plenary mode, the returned list contains all known
race constrainer or an error results. Otherwise, the returned list may
contain only those race constrainer that are accessible through this
session.
In active mode, race constrainers are returned that are currently
active. In any status mode, active and inactive race constrainer are
returned.raceConstrainerGenusType
- a race constrainer genus type RaceConstrainer
listNullArgumentException
- raceConstrainerGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RaceConstrainerList getRaceConstrainersByRecordType(Type raceConstrainerRecordType) throws OperationFailedException, PermissionDeniedException
RaceConstrainerList
containing the given race
constrainer record Type.
In plenary mode, the returned list contains all known
race constrainer or an error results. Otherwise, the returned list may
contain only those race constrainer that are accessible through this
session.
In active mode, race constrainers are returned that are currently
active. In any status mode, active and inactive race constrainer are
returned.raceConstrainerRecordType
- a race constrainer record type RaceConstrainer
listNullArgumentException
-
raceConstrainerRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RaceConstrainerList getRaceConstrainers() throws OperationFailedException, PermissionDeniedException
RaceConstrainers.
In plenary mode, the returned list contains all known race constrainer
or an error results. Otherwise, the returned list may contain only
those race constrainer that are accessible through this session.
In active mode, race constrainers are returned that are currently
active. In any status mode, active and inactive race constrainer are
returned. RaceConstrainer
listOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.