org.osid.voting.rules

Interface RaceProcessorSearchSession

All Superinterfaces:

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

Methods

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

canSearchRaceProcessors, getPolls, getPollsId, getRaceProcessorQuery, getRaceProcessorsByQuery, 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

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.