Interface RaceSearchSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession, RaceQuerySession

public interface RaceSearchSession
extends RaceQuerySession

This session provides methods for searching among races. The search query is constructed using the RaceQuery .

getRacesByQuery() is the basic search method and returns a list of races. A more advanced search may be performed with getRacesBySearch() .It accepts a RaceSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getRacesBySearch() returns a RaceSearchResults that can be used to access the resulting RaceList or be used to perform a search within the result set through RaceSearch .

This session defines views that offer differing behaviors for searching.

• federated polls view: searches include races in polls of which this polls is an ancestor in the polls hierarchy
• isolated polls view: searches are restricted to races in this polls only

Method Summary

Modifier and Type	Method	Description
RaceQuery	getRaceQueryFromInspector(RaceQueryInspector raceQueryInspector)	Gets a race query from an inspector.
RaceSearchResults	getRacesBySearch(RaceQuery raceQuery, RaceSearch raceSearch)	Gets the search results matching the given search query using the given search.
RaceSearch	getRaceSearch()	Gets a race search.
RaceSearchOrder	getRaceSearchOrder()	Gets a race search order.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Methods inherited from interface RaceQuerySession

canSearchRaces, getPolls, getPollsId, getRaceQuery, getRacesByQuery, useFederatedPollsView, useIsolatedPollsView

Modifier and Type	Method	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.

Method Details

getRaceSearch

RaceSearch getRaceSearch()

Gets a race search.

Returns:

the race search

Compliance:

mandatory - This method must be implemented.

getRaceSearchOrder

RaceSearchOrder getRaceSearchOrder()

Gets a race search order. The RaceSearchOrder is supplied to a RaceSearch to specify the ordering of results.

Returns:

the race search order

Compliance:

mandatory - This method must be implemented.

getRacesBySearch

RaceSearchResults getRacesBySearch(RaceQuery raceQuery,
 RaceSearch raceSearch)
                            throws OperationFailedException,
PermissionDeniedException

Gets the search results matching the given search query using the given search.

Parameters:

raceQuery - the race query

raceSearch - the race search

Returns:

the returned race search results

Throws:

NullArgumentException - raceQuery or raceSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - raceQuery or raceSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getRaceQueryFromInspector

RaceQuery getRaceQueryFromInspector(RaceQueryInspector raceQueryInspector)

Gets a race query from an inspector. The inspector is available from a RaceSearchResults .

Parameters:

raceQueryInspector - a race query inspector

Returns:

the race query

Throws:

NullArgumentException - raceQueryInspector is null

UnsupportedException - raceQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.