OSID Specifications
room construction package
Version 3.0.0
Release Candidate Preview
room construction package
Version 3.0.0
Release Candidate Preview
| Interface | osid.room.construction.RenovationSearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getRenovations | ||
| Description |
Gets the renovation list resulting from a search. | ||
| Return | osid.room.construction.RenovationList | the renovation list | |
| Errors | ILLEGAL_STATE | list has already been retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRenovationQueryInspector | ||
| Description |
Gets the inspector for the query to examine the terns used in the search. | ||
| Return | osid.room.construction.RenovationQueryInspector | the query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRenovationSearchResultsRecord | ||
| Description |
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 | osid.type.Type | renovationSearchRecordType | a renovation search record type |
| Return | osid.room.construction.records.RenovationSearchResultsRecord | the renovation search results 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. | |