public interface RaceConstrainerQuerySession extends OsidSession
This session provides methods for searching among
RaceConstrainer
objects. The search query is constructed using the
RaceConstrainerQuery.
This session defines views that offer differing behaviors for searching.
Race constrainer may have a query record indicated by their respective
record types. The query record is accessed via the
RaceConstrainerQuery.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchRaceConstrainers()
Tests if this user can perform
RaceConstrainer lookups. |
Polls |
getPolls()
Gets the
Polls associated with this session. |
Id |
getPollsId()
Gets the
Polls Id associated with this
session. |
RaceConstrainerQuery |
getRaceConstrainerQuery()
Gets a race constrainer query.
|
RaceConstrainerList |
getRaceConstrainersByQuery(RaceConstrainerQuery raceConstrainerQuery)
Gets a list of
RaceConstrainers matching the given race
constrainer query. |
void |
useFederatedPollsView()
Federates the view for methods in this session.
|
void |
useIsolatedPollsView()
Isolates the view for methods in this session.
|
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 canSearchRaceConstrainers()
RaceConstrainer
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 not offer lookup operations to
unauthorized users. false
if search methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useFederatedPollsView()
mandatory
- This method is must be implemented. void useIsolatedPollsView()
mandatory
- This method is must be implemented. RaceConstrainerQuery getRaceConstrainerQuery()
mandatory
- This method must be implemented. RaceConstrainerList getRaceConstrainersByQuery(RaceConstrainerQuery raceConstrainerQuery) throws OperationFailedException, PermissionDeniedException
RaceConstrainers
matching the given race
constrainer query.raceConstrainerQuery
- the race constrainer query RaceConstrainerList
NullArgumentException
- raceConstrainerQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- raceConstrainerQuery
is not of this servicemandatory
- This method must be implemented.