public interface RenovationSearch extends OsidSearch
The search interface for governing renovation searches.
Modifier and Type | Method and Description |
---|---|
RenovationSearchRecord |
getRenovationSearchRecord(Type renovationSearchRecordType)
Gets the dis[atch search record corresponding to the given renovation
search record
Type. |
void |
orderRenovationResults(RenovationSearchOrder renovationSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongRenovations(IdList renovationIds)
Execute this search among the given list of renovations.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongRenovations(IdList renovationIds)
renovationIds
- list of renovationsNullArgumentException
- renovationIds
is
null
mandatory
- This method must be implemented. void orderRenovationResults(RenovationSearchOrder renovationSearchOrder)
renovationSearchOrder
- renovation search orderNullArgumentException
- renovationSearchOrder
is null
UnsupportedException
- renovationSearchOrder
is not of this servicemandatory
- This method must be implemented. RenovationSearchRecord getRenovationSearchRecord(Type renovationSearchRecordType) throws OperationFailedException
Type.
This method is used to retrieve an
object implementing the requested record.renovationSearchRecordType
- a renovation search record typeNullArgumentException
-
renovationSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(renovationSearchRecordType)
is
false
mandatory
- This method must be implemented.