Interface | osid.contact.AddressAddressBookSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to retrieve This lookup session defines several views:
| ||
Method | canLookupAddressAddressBookMappings | ||
Description |
Tests if this user can perform lookups of
address/address book mappings. A return of true does not
guarantee successful authorization. A return of false
indicates that it is known lookup methods in this session
will result in a | ||
Return | boolean | false if looking up mappings is not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativeAddressBookView | ||
Description |
The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | usePlenaryAddressBookView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getAddressIdsByAddressBook | ||
Description |
Gets the list of Address Ids associated with an | ||
Parameters | osid.id.Id | addressBookId | Id of an AddressBook. |
Return | osid.id.IdList | list of related address Ids | |
Errors | NOT_FOUND | addressBookId is not found | |
NULL_ARGUMENT | addressBookId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAddressesByAddressBook | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | addressBookId | Id of an AddressBook |
Return | osid.contact.AddressList | list of related addresses | |
Errors | NOT_FOUND | addressBookId is not found | |
NULL_ARGUMENT | addressBookId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAddressIdsByAddressBooks | ||
Description |
Gets the list of | ||
Parameters | osid.id.IdList | addressBookIds | list of address book Ids |
Return | osid.id.IdList | list of address Ids | |
Errors | NULL_ARGUMENT | addressBookIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAddressesByAddressBooks | ||
Description |
Gets the list of | ||
Parameters | osid.id.IdList | addressBookIds | list of address book Ids |
Return | osid.contact.AddressList | list of addresses | |
Errors | NULL_ARGUMENT | addressBookIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAddressBookIdsByAddress | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | addressId | Id of an Address |
Return | osid.id.IdList | list of address book Ids | |
Errors | NOT_FOUND | addressId is not found | |
NULL_ARGUMENT | addressId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAddressBooksByAddress | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | addressId | Id of an Address |
Return | osid.contact.AddressBookList | list of address books | |
Errors | NOT_FOUND | addressId is not found | |
NULL_ARGUMENT | addressId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |