Interface RenovationSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface RenovationSearch
extends OsidSearch

The search interface for governing renovation searches.

Method Summary

Modifier and Type	Method	Description
RenovationSearchRecord	getRenovationSearchRecord(Type renovationSearchRecordType)	Gets the dis[atch search record corresponding to the given renovation search record Type .This method is used to retrieve an object implementing the requested record.
void	orderRenovationResults(RenovationSearchOrder renovationSearchOrder)	Specify an ordering to the search results.
void	searchAmongRenovations(IdList renovationIds)	Execute this search among the given list of renovations.

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

searchAmongRenovations

void searchAmongRenovations(IdList renovationIds)

Execute this search among the given list of renovations.

Parameters:

renovationIds - list of renovations

Throws:

NullArgumentException - renovationIds is null

Compliance:

mandatory - This method must be implemented.

orderRenovationResults

void orderRenovationResults(RenovationSearchOrder renovationSearchOrder)

Specify an ordering to the search results.

Parameters:

renovationSearchOrder - renovation search order

Throws:

NullArgumentException - renovationSearchOrder is null

UnsupportedException - renovationSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getRenovationSearchRecord

RenovationSearchRecord getRenovationSearchRecord(Type renovationSearchRecordType)
                                          throws OperationFailedException

Gets the dis[atch search 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 record

Throws:

NullArgumentException - renovationSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(renovationSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.