Interface RaceProcessorSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface RaceProcessorSearchResults
extends OsidSearchResults

This interface provides a means to capture results of a search.

Method Summary

Modifier and Type	Method	Description
RaceProcessorQueryInspector	getRaceProcessorQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
RaceProcessorList	getRaceProcessors()	Gets the RaceProcessorList resulting from a search.
RaceProcessorSearchResultsRecord	getRaceProcessorSearchResultsRecord(Type raceProcessorSearchRecordType)	Gets the race processor search results record corresponding to the given race processor search record Type .This method must be used to retrieve an object implementing the requested record.

Methods inherited from interface Browsable

getProperties, getPropertiesByRecordType

Modifier and Type	Method	Description
PropertyList	getProperties()	Gets a list of properties.
PropertyList	getPropertiesByRecordType(Type recordType)	Gets a list of properties corresponding to the specified record type.

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 OsidSearchResults

getResultSize

Modifier and Type	Method	Description
long	getResultSize()	Returns the size of a result set from a search query.

Method Details

getRaceProcessors

RaceProcessorList getRaceProcessors()

Gets the RaceProcessorList resulting from a search.

Returns:

the race processor list

Throws:

IllegalStateException - list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getRaceProcessorQueryInspector

RaceProcessorQueryInspector getRaceProcessorQueryInspector()

Gets the inspector for the query to examine the terms used in the search.

Returns:

the race processor query inspector

Compliance:

mandatory - This method must be implemented.

getRaceProcessorSearchResultsRecord

RaceProcessorSearchResultsRecord getRaceProcessorSearchResultsRecord(Type raceProcessorSearchRecordType)
                                                              throws OperationFailedException,
PermissionDeniedException

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

Parameters:

raceProcessorSearchRecordType - a race processor search record type

Returns:

the race processor search results record

Throws:

NullArgumentException - raceProcessorSearchRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(raceProcessorSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.