Interface | osid.room.construction.RenovationSearch | ||
---|---|---|---|
Implements | osid.OsidSearch | ||
Description |
The search interface for governing renovation searches. | ||
Method | searchAmongRenovations | ||
Description |
Execute this search among the given list of renovations. | ||
Parameters | osid.id.IdList | renovationIds | list of renovations |
Errors | NULL_ARGUMENT | renovationIds is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderRenovationResults | ||
Description |
Specify an ordering to the search results. | ||
Parameters | osid.room.construction.RenovationSearchOrder | renovationSearchOrder | renovation search order |
Errors | NULL_ARGUMENT | renovationSearchOrder is null | |
UNSUPPORTED | renovationSearchOrder is not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRenovationSearchRecord | ||
Description |
Gets the dis[atch search record corresponding to the
given renovation search record | ||
Parameters | osid.type.Type | renovationSearchRecordType | a renovation search record type |
Return | osid.room.construction.records.RenovationSearchRecord | the renovation search record | |
Errors | NULL_ARGUMENT | renovationSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(renovationSearchRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |