Interface RaceConstrainerSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface RaceConstrainerSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
RaceConstrainerQueryInspector	getRaceConstrainerQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
RaceConstrainerList	getRaceConstrainers()	Gets the RaceConstrainerList resulting from a search.
RaceConstrainerSearchResultsRecord	getRaceConstrainerSearchResultsRecord(Type raceConstrainerSearchRecordType)	Gets the race constrainer search results record corresponding to the given race constrainer 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

getRaceConstrainers

RaceConstrainerList getRaceConstrainers()

Gets the RaceConstrainerList resulting from a search.

Returns:

the race constrainer list

Throws:

IllegalStateException - list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getRaceConstrainerQueryInspector

RaceConstrainerQueryInspector getRaceConstrainerQueryInspector()

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

Returns:

the race constrainer query inspector

Compliance:

mandatory - This method must be implemented.

getRaceConstrainerSearchResultsRecord

RaceConstrainerSearchResultsRecord getRaceConstrainerSearchResultsRecord(Type raceConstrainerSearchRecordType)
                                                                  throws OperationFailedException,
PermissionDeniedException

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

Parameters:

raceConstrainerSearchRecordType - a race constrainer search record type

Returns:

the race constrainer search results record

Throws:

NullArgumentException - raceConstrainerSearchRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(raceConstrainerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.