Interface RenovationSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface RenovationSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
RenovationQueryInspector	getRenovationQueryInspector()	Gets the inspector for the query to examine the terns used in the search.
RenovationList	getRenovations()	Gets the renovation list resulting from a search.
RenovationSearchResultsRecord	getRenovationSearchResultsRecord(Type renovationSearchRecordType)	Gets the renovation search results record corresponding to the given renovation search record Type.

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

getRenovations

RenovationList getRenovations()

Gets the renovation list resulting from a search.

Returns:

the renovation list

Throws:

IllegalStateException - list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getRenovationQueryInspector

RenovationQueryInspector getRenovationQueryInspector()

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

Returns:

the query inspector

Compliance:

mandatory - This method must be implemented.

getRenovationSearchResultsRecord

RenovationSearchResultsRecord getRenovationSearchResultsRecord(Type renovationSearchRecordType)
                                                        throws OperationFailedException

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

Parameters:

renovationSearchRecordType - a renovation search record type

Returns:

the renovation search results record

Throws:

NullArgumentException - RenovationSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(renovationSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.