Interface | osid.contact.AddressBookSearchSession | ||
---|---|---|---|
Implements | osid.contact.AddressBookQuerySession | ||
Description |
This session provides methods for searching AddressBooks may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
Method | getAddressBookSearch | ||
Description |
Gets an address book search. | ||
Return | osid.contact.AddressBookSearch | the address book search | |
Compliance | mandatory | This method must be implemented. | |
Method | getAddressBookSearchOrder | ||
Description |
Gets an address book search order. The | ||
Return | osid.contact.AddressBookSearchOrder | the address book search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getAddressBooksBySearch | ||
Description |
Gets the search results matching the given search. | ||
Parameters | osid.contact.AddressBookQuery | addressBookQuery | the address book query |
osid.contact.AddressBookSearch | addressBookSearch | the address book search | |
Return | osid.contact.AddressBookSearchResults | the address book search results | |
Errors | NULL_ARGUMENT | addressBookQuery or address books earch is
null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | addressBookQuery or address books earch is
not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAddressBookQueryFromInspector | ||
Description |
Gets an address book query from an inspector. The
inspector is available from an | ||
Parameters | osid.contact.AddressBookQueryInspector | addressBookQueryInspector | an address book query inspector |
Return | osid.contact.AddressBookQuery | the address book query | |
Errors | NULL_ARGUMENT | addressBookQueryInspector is null | |
UNSUPPORTED | addressBookQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |