OSID Specifications
contact package
Version 3.1.0
contact package
Version 3.1.0
| Interface | osid.contact.ContactSearchOrder | ||
|---|---|---|---|
| Implements | osid.OsidRelationshipSearchOrder | ||
| Used By | osid.contact.ContactSearchSession | ||
osid.contact.ContactSmartAddressBookSession | |||
| Description |
An interface for specifying the ordering of search results. | ||
| Method | orderByReference | ||
| Description |
Specifies a preference for ordering the result set by the reference. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByAddressee | ||
| 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 | supportsAddresseeSearchOrder | ||
| 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 | getAddresseeSearchOrder | ||
| 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 | orderByAddress | ||
| Description |
Specifies a preference for ordering the result set by the address. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsAddressSearchOrder | ||
| Description |
Tests if an address order interface is available. | ||
| Return | boolean | true if an address order is available, false
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAddressSearchOrder | ||
| Description |
Gets the address order. | ||
| Return | osid.contact.AddressSearchOrder | the address search order | |
| Errors | UNIMPLEMENTED | supportsAddressSearchOrder() is false | |
| Compliance | optional | This method must be implemented if
supportsAddressSearchOrder() is true. | |
| Method | getContactSearchOrderRecord | ||
| Description |
Gets the contact search order record corresponding to
the given contact record | ||
| Parameters | osid.type.Type | contactRecordType | a contact record type |
| Return | osid.contact.records.ContactSearchOrderRecord | the contact search order record | |
| Errors | NULL_ARGUMENT | contactRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(contactRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |