Interface RaceConstrainerSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface RaceConstrainerSearch
extends OsidSearch

The search interface for governing race constrainer searches.

Method Summary

Modifier and Type	Method	Description
RaceConstrainerSearchRecord	getRaceConstrainerSearchRecord(Type raceConstrainerSearchRecordType)	Gets the race constrainer search record corresponding to the given race constrainer search record Type .This method is used to retrieve an object implementing the requested record.
void	orderRaceConstrainerResults(RaceConstrainerSearchOrder raceConstrainerSearchOrder)	Specify an ordering to the search results.
void	searchAmongRaceConstrainers(IdList pollsIds)	Execute this search among the given list of race constrainers.

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

searchAmongRaceConstrainers

void searchAmongRaceConstrainers(IdList pollsIds)

Execute this search among the given list of race constrainers.

Parameters:

pollsIds - list of race constrainers

Throws:

NullArgumentException - pollsIds is null

Compliance:

mandatory - This method must be implemented.

orderRaceConstrainerResults

void orderRaceConstrainerResults(RaceConstrainerSearchOrder raceConstrainerSearchOrder)

Specify an ordering to the search results.

Parameters:

raceConstrainerSearchOrder - race constrainer search order

Throws:

NullArgumentException - raceConstrainerSearchOrder is null

UnsupportedException - raceConstrainerSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getRaceConstrainerSearchRecord

RaceConstrainerSearchRecord getRaceConstrainerSearchRecord(Type raceConstrainerSearchRecordType)
                                                    throws OperationFailedException

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

Parameters:

raceConstrainerSearchRecordType - a race constrainer search record type

Returns:

the race constrainer search record

Throws:

NullArgumentException - raceConstrainerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(raceConstrainerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.