Interface | osid.contact.rules.ContactEnablerAddressBookSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to retrieve This lookup session defines several views:
| ||
Method | canLookupContactEnablerAddressBookMappings | ||
Description |
Tests if this user can perform lookups of contact
enabler/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 | useComparativeContactEnablerAddressBookView | ||
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 | usePlenaryContactEnablerAddressBookView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getContactEnablerIdsByAddressBook | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | addressBookId | Id of the AddressBook |
Return | osid.id.IdList | list of related contact enabler 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 | getContactEnablersByAddressBook | ||
Description |
Gets the list of contact enablers associated with an
| ||
Parameters | osid.id.Id | addressBookId | Id of the AddressBook |
Return | osid.contact.rules.ContactEnablerList | list of related contact enablers | |
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 | getContactEnablerIdsByAddressBooks | ||
Description |
Gets the list of | ||
Parameters | osid.id.IdList | addressBookIds | list of address book Ids |
Return | osid.id.IdList | list of contact enabler 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 | getContactEnablersByAddressBooks | ||
Description |
Gets the list of contact enablers corresponding to a
list of | ||
Parameters | osid.id.IdList | addressBookIds | list of address book Ids |
Return | osid.contact.rules.ContactEnablerList | list of contact enablers | |
Errors | NULL_ARGUMENT | addressBookIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAddressBookIdsByContactEnabler | ||
Description |
Gets the | ||
Parameters | osid.id.Id | contactEnablerId | Id of a ContactEnabler |
Return | osid.id.IdList | list of address books | |
Errors | NOT_FOUND | contactEnablerId is not found | |
NULL_ARGUMENT | contactEnablerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAddressBooksByContactEnabler | ||
Description |
Gets the | ||
Parameters | osid.id.Id | contactEnablerId | Id of a ContactEnabler |
Return | osid.contact.AddressBookList | list of address books | |
Errors | NOT_FOUND | contactEnablerId is not found | |
NULL_ARGUMENT | contactEnablerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |