| Interface | osid.offering.CanonicalUnitSearchOrder | ||
|---|---|---|---|
| Implements | osid.OsidObjectSearchOrder | ||
osid.OsidOperableSearchOrder | |||
| Description | 
                 An interface for specifying the ordering of search results.  | ||
| Method | orderByTitle | ||
| Description | 
                     Specifies a preference for ordering the result set by the title.  | ||
| Parameters | osid.SearchOrderStyle | style | search order style | 
| Errors | NULL_ARGUMENT |  style  is  null   |                 |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByCode | ||
| Description | 
                     Specifies a preference for ordering the result set by the code.  | ||
| Parameters | osid.SearchOrderStyle | style | search order style | 
| Errors | NULL_ARGUMENT |  style  is  null   |                 |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCanonicalUnitSearchOrderRecord | ||
| Description | 
                     Gets the canonical unit search order record 
                    corresponding to the given canonical unit record   | ||
| Parameters | osid.type.Type | canonicalUnitRecordType | a canonical unit record type | 
| Return | osid.offering.records.CanonicalUnitSearchOrderRecord | the canonical unit search order record | |
| Errors | NULL_ARGUMENT |  canonicalUnitRecordType  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED |  hasRecordType(canonicalUnitRecordType)  is  false 
  |                 ||
| Compliance | mandatory | This method must be implemented. | |