Interface | osid.contact.AddressBookSearch | ||
---|---|---|---|
Implements | osid.OsidSearch | ||
Description |
The search interface for governing address book searches. | ||
Method | searchAmongAddressBooks | ||
Description |
Execute this search among the given list of address books. | ||
Parameters | osid.id.IdList | addressBookIds | list of address books |
Errors | NULL_ARGUMENT | addressBookIds is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderAddressBookResults | ||
Description |
Specify an ordering to the search results. | ||
Parameters | osid.contact.AddressBookSearchOrder | addressBooksearchOrder | address book search order |
Errors | NULL_ARGUMENT | addressBooksearchOrder is null | |
UNSUPPORTED | addressBooksearchOrder is not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAddressBookSearchRecord | ||
Description |
Gets the address book search record corresponding to
the given address book search record | ||
Parameters | osid.type.Type | addressBookSearchRecordType | an address book search record type |
Return | osid.contact.records.AddressBookSearchRecord | the address book search record | |
Errors | NULL_ARGUMENT | addressBooksearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(addressBooksearchRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |