public interface RaceQuerySession extends OsidSession
This session provides methods for searching among races. The race query
is constructed using the RaceQuery.
This session defines views that offer differing behaviors for searching.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchRaces()
Tests if this user can perform
Race searches. |
Polls |
getPolls()
Gets the
Polls associated with this session. |
Id |
getPollsId()
Gets the
Polls Id associated with this
session. |
RaceQuery |
getRaceQuery()
Gets a race query.
|
RaceList |
getRacesByQuery(RaceQuery raceQuery)
Gets a list of races matching the given race qiery.
|
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. Polls
associated with this sessionOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canSearchRaces()
Race
searches. 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 search 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. RaceQuery getRaceQuery()
mandatory
- This method must be implemented. RaceList getRacesByQuery(RaceQuery raceQuery) throws OperationFailedException, PermissionDeniedException
raceQuery
- the race query RaceList
NullArgumentException
- raceQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- raceQuery
is not
of this servicemandatory
- This method must be implemented.