Interface | osid.contact.AddressBookQuerySession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
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 | canSearchAddressBooks | ||
Description |
Tests if this user can perform | ||
Return | boolean | false if search methods are not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getAddressBookQuery | ||
Description |
Gets an address book query. | ||
Return | osid.contact.AddressBookQuery | the address book query | |
Compliance | mandatory | This method must be implemented. | |
Method | getAddressBooksByQuery | ||
Description |
Gets a list of | ||
Parameters | osid.contact.AddressBookQuery | addressBookQuery | the address book query |
Return | osid.contact.AddressBookList | the returned AddressBookList | |
Errors | NULL_ARGUMENT | addressBookQuery is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | addressBookQuery is not of this service | ||
Compliance | mandatory | This method must be implemented. |