| Interface | osid.room.construction.ProjectSearchOrder | ||
|---|---|---|---|
| Implements | osid.OsidObjectSearchOrder | ||
osid.OsidTemporalSearchOrder | |||
| Description | 
                 An interface for specifying the ordering of search results.  | ||
| Method | orderByBuilding | ||
| Description | 
                     Specifies a preference for ordering the result set by the building.  | ||
| Parameters | osid.SearchOrderStyle | style | search order style | 
| Errors | NULL_ARGUMENT |  style  is  null   |                 |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsBuildingSearchOrder | ||
| Description | 
                     Tests if a building search order is available.  | ||
| Return | boolean |  true  if a building search order is available,  false 
 otherwise  | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getBuildingSearchOrder | ||
| Description | 
                     Gets the building search order.  | ||
| Return | osid.room.BuildingSearchOrder | the building search order | |
| Errors | UNIMPLEMENTED |  supportsBuildingSearchOrder()  is  false   |                 |
| Compliance | optional | This method must be implemented if  supportsBuildingSearchOrder() 
 is  true.   | |
| 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 | getProjectSearchOrderRecord | ||
| Description | 
                     Gets the project search order record corresponding to the given project record Type. Multiple retrievals return the same underlying object.  | ||
| Parameters | osid.type.Type | projectRecordType | a project record type | 
| Return | osid.room.construction.records.ProjectSearchOrderRecord | the project search order record | |
| Errors | NULL_ARGUMENT |  projectRecordType  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED |  hasRecordType(projectRecordType)  is  false   |                 ||
| Compliance | mandatory | This method must be implemented. | |