OSID Specifications
contact package
Version 3.1.0
contact package
Version 3.1.0
| Interface | osid.contact.AddressBookSearchOrder | ||
|---|---|---|---|
| Implements | osid.OsidCatalogSearchOrder | ||
| Used By | osid.contact.AddressBookSearchSession | ||
| Description |
An interface for specifying the ordering of search results. | ||
| Method | getAddressBookSearchOrderRecord | ||
| Description |
Gets the address book search order record corresponding to the given address book record Type. Multiple retrievals return the same underlying object. | ||
| Parameters | osid.type.Type | addressBookRecordType | an address book record type |
| Return | osid.contact.records.AddressBookSearchOrderRecord | the address book search order record | |
| Errors | NULL_ARGUMENT | addressBookRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(addressBookRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |