Interface RaceProcessorEnablerSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface RaceProcessorEnablerSearch
extends OsidSearch

The search interface for governing race processor enabler searches.

Method Summary

Modifier and Type	Method	Description
RaceProcessorEnablerSearchRecord	getRaceProcessorEnablerSearchRecord(Type raceProcessorEnablerSearchRecordType)	Gets the race processor enabler search record corresponding to the given race processor enabler search record Type .This method is used to retrieve an object implementing the requested record.
void	orderRaceProcessorEnablerResults(RaceProcessorEnablerSearchOrder raceProcessorEnablerSearchOrder)	Specify an ordering to the search results.
void	searchAmongRaceProcessorEnablers(IdList raceProcessorEnablerIds)	Execute this search among the given list of race processor enablers.

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

searchAmongRaceProcessorEnablers

void searchAmongRaceProcessorEnablers(IdList raceProcessorEnablerIds)

Execute this search among the given list of race processor enablers.

Parameters:

raceProcessorEnablerIds - list of race processor enablers

Throws:

NullArgumentException - raceProcessorEnablerIds is null

Compliance:

mandatory - This method must be implemented.

orderRaceProcessorEnablerResults

void orderRaceProcessorEnablerResults(RaceProcessorEnablerSearchOrder raceProcessorEnablerSearchOrder)

Specify an ordering to the search results.

Parameters:

raceProcessorEnablerSearchOrder - race processor enabler search order

Throws:

NullArgumentException - raceProcessorEnablerSearchOrder is null

UnsupportedException - raceProcessorEnablerSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getRaceProcessorEnablerSearchRecord

RaceProcessorEnablerSearchRecord getRaceProcessorEnablerSearchRecord(Type raceProcessorEnablerSearchRecordType)
                                                              throws OperationFailedException

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

Parameters:

raceProcessorEnablerSearchRecordType - a race processor enabler search record type

Returns:

the race processor enabler search record

Throws:

NullArgumentException - raceProcessorEnablerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(raceProcessorEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.