public interface RaceConstrainerEnablerLookupSession extends OsidSession
This session provides methods for retrieving
RaceConstrainerEnablers.
This session defines views that offer differing behaviors when retrieving multiple objects.
RaceConstrainerEnablers
with the
RaceConstrainerEnablerAdminSession.
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 |
canLookupRaceConstrainerEnablers()
Tests if this user can perform
RaceConstrainerEnablers
lookups. |
Polls |
getPolls()
Gets the
Polls associated with this session. |
Id |
getPollsId()
Gets the
Polls Id associated with this
session. |
RaceConstrainerEnabler |
getRaceConstrainerEnabler(Id raceConstrainerEnablerId)
Gets the
RaceConstrainerEnabler specified by its
Id. |
RaceConstrainerEnablerList |
getRaceConstrainerEnablers()
Gets all
RaceConstrainerEnablers. |
RaceConstrainerEnablerList |
getRaceConstrainerEnablersByGenusType(Type raceConstrainerEnablerGenusType)
Gets a
RaceConstrainerEnablerList corresponding to the
given race constrainer enabler genus Type which does
not include race constrainer enablers of genus types derived from the
specified Type. |
RaceConstrainerEnablerList |
getRaceConstrainerEnablersByIds(IdList raceConstrainerEnablerIds)
Gets a
RaceConstrainerEnablerList corresponding to the
given IdList. |
RaceConstrainerEnablerList |
getRaceConstrainerEnablersByParentGenusType(Type raceConstrainerEnablerGenusType)
Gets a
RaceConstrainerEnablerList corresponding to the
given race constrainer enabler genus Type and include
any additional race constrainer enablers with genus types derived from
the specified Type. |
RaceConstrainerEnablerList |
getRaceConstrainerEnablersByRecordType(Type raceConstrainerEnablerRecordType)
Gets a
RaceConstrainerEnablerList containing the given
race constrainer enabler record Type. |
RaceConstrainerEnablerList |
getRaceConstrainerEnablersOnDate(DateTime from,
DateTime to)
Gets a
RaceConstrainerEnablerList that are effective
for the entire given date range inclusive but not confined to the date
range for any agent. |
RaceConstrainerEnablerList |
getRaceConstrainerEnablersOnDateWithAgent(Id agentId,
DateTime from,
DateTime to)
Gets a
RaceConstrainerEnablerList that are effective
for the entire given date range inclusive but not confined to the date
range and evaluated against the given agent. |
void |
useActiveRaceConstrainerEnablerView()
Only active race constrainer enablers are returned by methods in this
session.
|
void |
useAnyStatusRaceConstrainerEnablerView()
All active and inactive race constrainer enablers are returned by
methods in this session.
|
void |
useComparativeRaceConstrainerEnablerView()
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 |
usePlenaryRaceConstrainerEnablerView()
A complete view of the
RaceConstrainerEnabler 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 canLookupRaceConstrainerEnablers()
RaceConstrainerEnablers
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 useComparativeRaceConstrainerEnablerView()
mandatory
- This method is must be implemented. void usePlenaryRaceConstrainerEnablerView()
RaceConstrainerEnabler
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 useActiveRaceConstrainerEnablerView()
mandatory
- This method is must be implemented. void useAnyStatusRaceConstrainerEnablerView()
mandatory
- This method is must be implemented. RaceConstrainerEnabler getRaceConstrainerEnabler(Id raceConstrainerEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
RaceConstrainerEnabler
specified by its
Id.
In plenary mode, the exact Id
is found
or a NOT_FOUND
results. Otherwise, the returned
RaceConstrainerEnabler
may have a different Id
than requested, such as the case where a duplicate Id
was assigned to a RaceConstrainerEnabler
and retained
for compatibility.
In active mode, race constrainer enablers are returned that are
currently active. In any status mode, active and inactive race
constrainer enablers are returned.raceConstrainerEnablerId
- Id
of the
RaceConstrainerEnabler
NotFoundException
- raceConstrainerEnablerId
not foundNullArgumentException
- raceConstrainerEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. RaceConstrainerEnablerList getRaceConstrainerEnablersByIds(IdList raceConstrainerEnablerIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
RaceConstrainerEnablerList
corresponding to the
given IdList.
In plenary mode, the returned list contains all of the
race constrainer enablers 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 RaceConstrainerEnablers
may be
omitted from the list and may present the elements in any order
including returning a unique set.
In active mode, race constrainer enablers are returned that are
currently active. In any status mode, active and inactive race
constrainer enablers are returned.raceConstrainerEnablerIds
- the list of Ids
to
retrieve RaceConstrainerEnabler
listNotFoundException
- a Id
was not foundNullArgumentException
-
raceConstrainerEnablerIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RaceConstrainerEnablerList getRaceConstrainerEnablersByGenusType(Type raceConstrainerEnablerGenusType) throws OperationFailedException, PermissionDeniedException
RaceConstrainerEnablerList
corresponding to the
given race constrainer enabler genus Type
which does
not include race constrainer enablers of genus types derived from the
specified Type.
In plenary mode, the returned list contains all known
race constrainer enablers or an error results. Otherwise, the returned
list may contain only those race constrainer enablers that are
accessible through this session.
In active mode, race constrainer enablers are returned that are
currently active. In any status mode, active and inactive race
constrainer enablers are returned.raceConstrainerEnablerGenusType
- a race constrainer enabler
genus type RaceConstrainerEnabler
listNullArgumentException
-
raceConstrainerEnablerGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RaceConstrainerEnablerList getRaceConstrainerEnablersByParentGenusType(Type raceConstrainerEnablerGenusType) throws OperationFailedException, PermissionDeniedException
RaceConstrainerEnablerList
corresponding to the
given race constrainer enabler genus Type
and include
any additional race constrainer enablers with genus types derived from
the specified Type.
In plenary mode, the returned list contains all known
race constrainer enablers or an error results. Otherwise, the returned
list may contain only those race constrainer enablers that are
accessible through this session.
In active mode, race constrainer enablers are returned that are
currently active. In any status mode, active and inactive race
constrainer enablers are returned.raceConstrainerEnablerGenusType
- a race constrainer enabler
genus type RaceConstrainerEnabler
listNullArgumentException
-
raceConstrainerEnablerGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RaceConstrainerEnablerList getRaceConstrainerEnablersByRecordType(Type raceConstrainerEnablerRecordType) throws OperationFailedException, PermissionDeniedException
RaceConstrainerEnablerList
containing the given
race constrainer enabler record Type.
In plenary mode, the returned list contains all known
race constrainer enablers or an error results. Otherwise, the returned
list may contain only those race constrainer enablers that are
accessible through this session.
In active mode, race constrainer enablers are returned that are
currently active. In any status mode, active and inactive race
constrainer enablers are returned.raceConstrainerEnablerRecordType
- a race constrainer enabler
record type RaceConstrainerEnabler
listNullArgumentException
-
raceConstrainerEnablerRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RaceConstrainerEnablerList getRaceConstrainerEnablersOnDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
RaceConstrainerEnablerList
that are effective
for the entire given date range inclusive but not confined to the date
range for any agent.
In plenary mode, the returned list contains all known
race constrainer enablers or an error results. Otherwise, the returned
list may contain only those race constrainer enablers that are
accessible through this session.
In active mode, race constrainer enablers are returned that are
currently active. In any status mode, active and inactive race
constrainer enablers are returned.from
- a start dateto
- an end date RaceConstrainerEnabler
listInvalidArgumentException
- from
is
greater tha to
NullArgumentException
- from
or
to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RaceConstrainerEnablerList getRaceConstrainerEnablersOnDateWithAgent(Id agentId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
RaceConstrainerEnablerList
that are effective
for the entire given date range inclusive but not confined to the date
range and evaluated against the given agent.
In plenary mode, the returned list contains all known
race constrainer enablers or an error results. Otherwise, the returned
list may contain only those race constrainer enablers that are
accessible through this session.
In active mode, race constrainer enablers are returned that are
currently active. In any status mode, active and inactive race
constrainer enablers are returned.agentId
- an agent Id
from
- a start dateto
- an end date RaceConstrainerEnabler
listInvalidArgumentException
- from
is
greater tha to
NullArgumentException
- agentId, from,
or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RaceConstrainerEnablerList getRaceConstrainerEnablers() throws OperationFailedException, PermissionDeniedException
RaceConstrainerEnablers.
In plenary mode, the returned list contains all known race constrainer
enablers or an error results. Otherwise, the returned list may contain
only those race constrainer enablers that are accessible through this
session.
In active mode, race constrainer enablers are returned that are
currently active. In any status mode, active and inactive race
constrainer enablers are returned. RaceConstrainerEnabler
listOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.