Interface RaceSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface RaceSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
RaceQueryInspector	getRaceQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
RaceList	getRaces()	Gets the race list resulting from a search.
RaceSearchResultsRecord	getRaceSearchResultsRecord(Type raceSearchRecordType)	Gets the race search results record corresponding to the given race search record Type .This method is 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

getRaces

RaceList getRaces()

Gets the race list resulting from a search.

Returns:

the race list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getRaceQueryInspector

RaceQueryInspector getRaceQueryInspector()

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

Returns:

the race query inspector

Compliance:

mandatory - This method must be implemented.

getRaceSearchResultsRecord

RaceSearchResultsRecord getRaceSearchResultsRecord(Type raceSearchRecordType)
                                            throws OperationFailedException

Gets the race search results 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 results record

Throws:

NullArgumentException - raceSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordTypeType(raceSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.