org.osid.voting.rules

Interface RaceConstrainerSearchSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession, RaceConstrainerQuerySession

public interface RaceConstrainerSearchSession
extends RaceConstrainerQuerySession

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

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

This session defines views that offer differing behaviors for searching.

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

RaceConstrainers may have a query record indicated by their respective record types. The query record is accessed via the RaceConstrainerQuery.

Method Summary

Methods

Modifier and Type	Method and Description
RaceConstrainerQuery	getRaceConstrainerQueryFromInspector(RaceConstrainerQueryInspector raceConstrainerQueryInspector) Gets a race constrainer query from an inspector.
RaceConstrainerSearchResults	getRaceConstrainersBySearch(RaceConstrainerQuery raceConstrainerQuery, RaceConstrainerSearch raceConstrainerSearch) Gets the search results matching the given search query using the given search.
RaceConstrainerSearch	getRaceConstrainerSearch() Gets a race constrainer search.
RaceConstrainerSearchOrder	getRaceConstrainerSearchOrder() Gets a race constrainer search order.

Methods inherited from interface org.osid.voting.rules.RaceConstrainerQuerySession

canSearchRaceConstrainers, getPolls, getPollsId, getRaceConstrainerQuery, getRaceConstrainersByQuery, 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

getRaceConstrainerSearch

RaceConstrainerSearch getRaceConstrainerSearch()

Gets a race constrainer search.

Returns:

the race constrainer search

Compliance:

mandatory - This method must be implemented.

getRaceConstrainerSearchOrder

RaceConstrainerSearchOrder getRaceConstrainerSearchOrder()

Gets a race constrainer search order. The RaceConstrainerSearchOrder is supplied to a RaceConstrainerSearch to specify the ordering of results.

Returns:

the race constrainer search order

Compliance:

mandatory - This method must be implemented.

getRaceConstrainersBySearch

RaceConstrainerSearchResults getRaceConstrainersBySearch(RaceConstrainerQuery raceConstrainerQuery,
                                                       RaceConstrainerSearch raceConstrainerSearch)
                                                         throws OperationFailedException,
                                                                PermissionDeniedException

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

Parameters:

raceConstrainerQuery - the race constrainer query

raceConstrainerSearch - the race constrainer search

Returns:

the returned search results

Throws:

NullArgumentException - raceConstrainerQuery or raceConstrainerSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - raceConstrainerQuery or raceConstrainerSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getRaceConstrainerQueryFromInspector

RaceConstrainerQuery getRaceConstrainerQueryFromInspector(RaceConstrainerQueryInspector raceConstrainerQueryInspector)

Gets a race constrainer query from an inspector. The inspector is available from a RaceConstrainerSearchResults.

Parameters:

raceConstrainerQueryInspector - a race constrainer query inspector

Returns:

the race constrainer query

Throws:

NullArgumentException - raceConstrainerQueryInspector is null

UnsupportedException - raceConstrainerQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.