Interface RaceProcessorSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface RaceProcessorSearch
extends OsidSearch

The search interface for governing race processor searches.

Method Summary

Modifier and Type	Method	Description
RaceProcessorSearchRecord	getRaceProcessorSearchRecord(Type raceProcessorSearchRecordType)	Gets the race processor search record corresponding to the given race processor search record Type .This method is used to retrieve an object implementing the requested record.
void	orderRaceProcessorResults(RaceProcessorSearchOrder raceProcessorSearchOrder)	Specify an ordering to the search results.
void	searchAmongRaceProcessors(IdList pollsIds)	Execute this search among the given list of race processors.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidSearch

limitResultSet

Modifier and Type	Method	Description
void	limitResultSet(long start, long end)	By default, searches return all matching results.

Method Details

searchAmongRaceProcessors

void searchAmongRaceProcessors(IdList pollsIds)

Execute this search among the given list of race processors.

Parameters:

pollsIds - list of race processors

Throws:

NullArgumentException - pollsIds is null

Compliance:

mandatory - This method must be implemented.

orderRaceProcessorResults

void orderRaceProcessorResults(RaceProcessorSearchOrder raceProcessorSearchOrder)

Specify an ordering to the search results.

Parameters:

raceProcessorSearchOrder - race processor search order

Throws:

NullArgumentException - raceProcessorSearchOrder is null

UnsupportedException - raceProcessorSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getRaceProcessorSearchRecord

RaceProcessorSearchRecord getRaceProcessorSearchRecord(Type raceProcessorSearchRecordType)
                                                throws OperationFailedException

Gets the race processor search record corresponding to the given race processor search record Type .This method is used to retrieve an object implementing the requested record.

Parameters:

raceProcessorSearchRecordType - a race processor search record type

Returns:

the race processor search record

Throws:

NullArgumentException - raceProcessorSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(raceProcessorSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.