| Interface | osid.contact.AddressSearchOrder | ||
|---|---|---|---|
| Implements | osid.OsidObjectSearchOrder | ||
| Description | 
                 An interface for specifying the ordering of search results.  | ||
| Method | orderByResource | ||
| Description | 
                     Specifies a preference for ordering the result set by the resource.  | ||
| Parameters | osid.SearchOrderStyle | style | search order style | 
| Errors | NULL_ARGUMENT |  style  is  null   |                 |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsResourceSearchOrder | ||
| Description | 
                     Tests if a resource order is available.  | ||
| Return | boolean |  true  if a resource order is available,  false  
otherwise  | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getResourceSearchOrder | ||
| Description | 
                     Gets the resource order.  | ||
| Return | osid.resource.ResourceSearchOrder | the resource search order | |
| Errors | UNIMPLEMENTED |  supportsAddresseeSearchOrder()  is  false   |                 |
| Compliance | optional | This method must be implemented if  supportsAddresseeSearchOrder() 
 is  true.   | |
| Method | getAddressSearchOrderRecord | ||
| Description | 
                     Gets the address search order record corresponding to the given address record Type. Multiple retrievals return the same underlying object.  | ||
| Parameters | osid.type.Type | addressRecordType | an address record type | 
| Return | osid.contact.records.AddressSearchOrderRecord | the address search order record | |
| Errors | NULL_ARGUMENT |  addressRecordType  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED |  hasRecordType(addressRecordType)  is  false   |                 ||
| Compliance | mandatory | This method must be implemented. | |