Interface | osid.contact.AddressBookLookupSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods for retrieving This session defines views that offer differing behaviors when retrieving multiple objects.
| ||
Method | canLookupAddressBooks | ||
Description |
Tests if this user can perform | ||
Return | boolean | false if lookup methods are 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 | getAddressBook | ||
Description |
Gets the | ||
Parameters | osid.id.Id | jouralId | Id of the AddressBook |
Return | osid.contact.AddressBook | the address book | |
Errors | NOT_FOUND | addressBookId not found | |
NULL_ARGUMENT | addressBookId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getAddressBooksByIds | ||
Description |
Gets an | ||
Parameters | osid.id.IdList | addressBookIds | the list of Ids to retrieve |
Return | osid.contact.AddressBookList | the returned AddressBook list | |
Errors | NOT_FOUND | an Id was not found | |
NULL_ARGUMENT | addressBookIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAddressBooksByGenusType | ||
Description |
Gets an | ||
Parameters | osid.type.Type | addressBookGenusType | an address book genus type |
Return | osid.contact.AddressBookList | the returned AddressBook list | |
Errors | NULL_ARGUMENT | addressBookGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAddressBooksByParentGenusType | ||
Description |
Gets an | ||
Parameters | osid.type.Type | addressBookGenusType | an address book genus type |
Return | osid.contact.AddressBookList | the returned AddressBook list | |
Errors | NULL_ARGUMENT | addressBookGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAddressBooksByRecordType | ||
Description |
Gets an | ||
Parameters | osid.type.Type | addressBookRecordType | an address book record type |
Return | osid.contact.AddressBookList | the returned AddressBook list | |
Errors | NULL_ARGUMENT | addressBookRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAddressBooksByProvider | ||
Description |
Gets an | ||
Parameters | osid.id.Id | resourceId | a resource Id |
Return | osid.contact.AddressBookList | the returned AddressBook list | |
Errors | NULL_ARGUMENT | resourceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAddressBooks | ||
Description |
Gets all | ||
Return | osid.contact.AddressBookList | a list of AddressBooks | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |