org.osid.voting

Interface RaceSearchSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, 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

Methods

Modifier and Type	Method and 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 org.osid.voting.RaceQuerySession

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

Methods inherited from interface org.osid.OsidSession

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

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

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.