| Interface | osid.contact.ContactSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Used By | osid.contact.ContactManager | ||
osid.contact.ContactProxyManager | |||
| Description |
This session defines methods for evaluating and retrieving active and applicable contacts. | ||
| Method | getAddressBookId | ||
| Description |
Gets the | ||
| Return | osid.id.Id | the AddressBook Id associated with this session | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAddressBook | ||
| Description |
Gets the | ||
| Return | osid.contact.AddressBook | the address book | |
| Errors | OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | canGetContacts | ||
| Description |
Tests if this user can lookup contacts. A return of
true does not guarantee successful authorization. A return
of false indicates that it is known all methods in this
session will result in a | ||
| Return | boolean | false if contact lookup methods are not authorized,
true otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getApplicableContacts | ||
| Description |
Gets a list of all current available contacts
corresponding to a reference | ||
| Parameters | osid.id.Id | referenceId | the Id of the reference |
| Return | osid.contact.ContactList | the returned ContactList | |
| Errors | NULL_ARGUMENT | referenceId is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getApplicableContactsByGenusType | ||
| Description |
Gets all current available contacts for a reference and
by contact genus | ||
| Parameters | osid.id.Id | referenceId | the Id of the reference |
osid.type.Type | contactGenusType | a contact genus Type | |
| Return | osid.contact.ContactList | a list of contacts | |
| Errors | NULL_ARGUMENT | referenceId or contactGenusType is
null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |