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.RenovationSearchOrder | ||
|---|---|---|---|
| Implements | osid.OsidObjectSearchOrder | ||
osid.OsidTemporalSearchOrder | |||
| Description |
An interface for specifying the ordering of search results. | ||
| Method | orderByCost | ||
| Description |
Specifies a preference for ordering the result set by the cost. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRenovationSearchOrderRecord | ||
| Description |
Gets the renovation search order record corresponding to the given renovation record Type. Multiple retrievals return the same underlying object. | ||
| Parameters | osid.type.Type | renovationRecordType | a renovation record type |
| Return | osid.room.construction.records.RenovationSearchOrderRecord | the renovation search order record | |
| Errors | NULL_ARGUMENT | renovationRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(renovationRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |