Interface RaceSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface RaceSearch
extends OsidSearch

The search interface for governing race searches.

Method Summary

Modifier and Type	Method	Description
RaceSearchRecord	getRaceSearchRecord(Type raceSearchRecordType)	Gets the race search record corresponding to the given race search record Type.
void	orderRaceResults(RaceSearchOrder raceSearchOrder)	Specify an ordering to the search results.
void	searchAmongRaces(IdList raceIds)	Execute this search among the given list of races.

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

searchAmongRaces

void searchAmongRaces(IdList raceIds)

Execute this search among the given list of races.

Parameters:

raceIds - list of race Ids

Throws:

NullArgumentException - raceIds is null

Compliance:

mandatory - This method must be implemented.

orderRaceResults

void orderRaceResults(RaceSearchOrder raceSearchOrder)

Specify an ordering to the search results.

Parameters:

raceSearchOrder - race search order

Throws:

NullArgumentException - raceSearchOrder is null

UnsupportedException - raceSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getRaceSearchRecord

RaceSearchRecord getRaceSearchRecord(Type raceSearchRecordType)
                              throws OperationFailedException

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

Parameters:

raceSearchRecordType - a race search record type

Returns:

the race search record

Throws:

NullArgumentException - raceSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordTypeType(raceSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.