Interface RaceProcessorSearchSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession, RaceProcessorQuerySession

public interface RaceProcessorSearchSession
extends RaceProcessorQuerySession

This session provides methods for searching among RaceProcessor objects. The search query is constructed using the RaceProcessoryQuery.

getRaceProcessorsByQuery() is the basic search method and returns a list of RaceProcessors. A more advanced search may be performed with getRaceProcessorsBySearch().It accepts a RaceProcessorSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as voting. getRaceProcessorsBySearch() returns a RaceProcessorSearchResults that can be used to access the resulting RaceProcessorList or be used to perform a search within the result set through RaceProcessorSearch.

This session defines views that offer differing behaviors for searching.

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

RaceProcessors may have a query record indicated by their respective record types. Thequery record is accessed via the RaceProcessorQuery.

Method Summary

Modifier and Type	Method	Description
RaceProcessorQuery	getRaceProcessorQueryFromInspector(RaceProcessorQueryInspector raceProcessorQueryInspector)	Gets a race processor query from an inspector.
RaceProcessorSearchResults	getRaceProcessorsBySearch(RaceProcessorQuery raceProcessorQuery, RaceProcessorSearch raceProcessorSearch)	Gets the search results matching the given search query using the given search.
RaceProcessorSearch	getRaceProcessorSearch()	Gets a race processor search.
RaceProcessorSearchOrder	getRaceProcessorSearchOrder()	Gets a race processor 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 RaceProcessorQuerySession

canSearchRaceProcessors, getPolls, getPollsId, getRaceProcessorQuery, getRaceProcessorsByQuery, useFederatedPollsView, useIsolatedPollsView

Modifier and Type	Method	Description
boolean	canSearchRaceProcessors()	Tests if this user can perform RaceProcessor lookups.
Polls	getPolls()	Gets the Polls associated with this session.
Id	getPollsId()	Gets the Polls Id associated with this session.
RaceProcessorQuery	getRaceProcessorQuery()	Gets a race processor query.
RaceProcessorList	getRaceProcessorsByQuery(RaceProcessorQuery raceProcessorQuery)	Gets a list of RaceProcessors matching the given race processor query.
void	useFederatedPollsView()	Federates the view for methods in this session.
void	useIsolatedPollsView()	Isolates the view for methods in this session.

Method Details

getRaceProcessorSearch

RaceProcessorSearch getRaceProcessorSearch()

Gets a race processor search.

Returns:

the race processor search

Compliance:

mandatory - This method must be implemented.

getRaceProcessorSearchOrder

RaceProcessorSearchOrder getRaceProcessorSearchOrder()

Gets a race processor search order. The RaceProcessorSearchOrder is supplied to a RaceProcessorSearch to specify the ordering of results.

Returns:

the race processor search order

Compliance:

mandatory - This method must be implemented.

getRaceProcessorsBySearch

RaceProcessorSearchResults getRaceProcessorsBySearch(RaceProcessorQuery raceProcessorQuery,
 RaceProcessorSearch raceProcessorSearch)
                                              throws OperationFailedException,
PermissionDeniedException

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

Parameters:

raceProcessorQuery - the race processor query

raceProcessorSearch - the race processor search

Returns:

the returned search results

Throws:

NullArgumentException - raceProcessorQuery or raceProcessorSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - raceProcessorQuery or raceProcessorSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getRaceProcessorQueryFromInspector

RaceProcessorQuery getRaceProcessorQueryFromInspector(RaceProcessorQueryInspector raceProcessorQueryInspector)

Gets a race processor query from an inspector. The inspector is available from a RaceProcessorSearchResults.

Parameters:

raceProcessorQueryInspector - a race processor query inspector

Returns:

the race processor query

Throws:

NullArgumentException - raceProcessorQueryInspector is null

UnsupportedException - raceProcessorQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.