org.osid.contact

Interface ContactProxyManager

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, ContactProfile, OsidProfile, OsidProxyManager, Sourceable

public interface ContactProxyManager
extends OsidProxyManager, ContactProfile

The contact manager provides access to contact sessions and provides interoperability tests for various aspects of this service. Methods in this manager accept a Proxy for passing information from a server environment. The sessions included in this manager are:

• ContactSession : a session to get available contacts for a resource
• ContactLookupSession: a session to lookup contacts
• ContactQuerySession: a session to query contacts
• ContactSearchSession: a session to search contacts
• ContactAdminSession: a session to manage contacts
• ContactNotificationSession: a session to subscribe to notifications of contact changes
• ContactAddressBookSession: a session to lookup contact address book mappings
• ContactAddressBookAssignmentSession: a session to manage contact address book mappings
• ContactSmartAddressBookSession: a session to manage smart address books of contacts
• AddressLookupSession: a session to retrieve addresses
• AddressQuerySession: a session to query addresses
• AddressSearchSession: a session to search for addresses
• AddressAdminSession: a session to create, update and delete addresses
• AddressNotificationSession: a session to receive notifications for changes in addresses
• AddressAddressBookSession: a session to lookup address address book mappings
• AddressAddressBookAssignmentSession: a session to manage address address book mappings
• AddressSmartAddressBookSession: a session to manage smart address books of addresses

• AddressBookLookupSession: a session to retrieve address books
• AddressBookQuerySession: a session to query address books
• AddressBookSearchSession: a session to search for address books
• AddressBookAdminSession: a session to create, update and delete address books
• AddressBookNotificationSession: a session to receive notifications for changes in address books
• AddressBookHierarchyTraversalSession: a session to traverse hierarchies of address books
• AddressBookHierarchyDesignSession: a session to manage hierarchies of address books

The contact manager also provides a profile for determing the supported search types supported by this service.

Method Summary

Methods

Modifier and Type	Method and Description
AddressAddressBookAssignmentSession	getAddressAddressBookAssignmentSession(Proxy proxy) Gets the session for assigning address to address book mappings.
AddressAddressBookSession	getAddressAddressBookSession(Proxy proxy) Gets the session for retrieving address to address book mappings.
AddressAdminSession	getAddressAdminSession(Proxy proxy) Gets the OsidSession associated with the address administrative service.
AddressAdminSession	getAddressAdminSessionForAddressBook(Id addressBookId, Proxy proxy) Gets the OsidSession associated with the address administration service for the given address book.
AddressBookAdminSession	getAddressBookAdminSession(Proxy proxy) Gets the OsidSession associated with the address book administrative service.
AddressBookHierarchyDesignSession	getAddressBookHierarchyDesignSession(Proxy proxy) Gets the OsidSession associated with the address book hierarchy design service.
AddressBookHierarchySession	getAddressBookHierarchySession(Proxy proxy) Gets the OsidSession associated with the address book hierarchy service.
AddressBookLookupSession	getAddressBookLookupSession(Proxy proxy) Gets the OsidSession associated with the address book lookup service.
AddressBookNotificationSession	getAddressBookNotificationSession(AddressBookReceiver addressBookReceiver, Proxy proxy) Gets the OsidSession associated with the address book notification service.
AddressBookQuerySession	getAddressBookQuerySession(Proxy proxy) Gets the OsidSession associated with the address book query service.
AddressBookSearchSession	getAddressBookSearchSession(Proxy proxy) Gets the OsidSession associated with the address book search service.
AddressLookupSession	getAddressLookupSession(Proxy proxy) Gets the OsidSession associated with the address lookup service.
AddressLookupSession	getAddressLookupSessionForAddressBook(Id addressBookId, Proxy proxy) Gets the OsidSession associated with the address lookup service for the given address book.
AddressNotificationSession	getAddressNotificationSession(AddressReceiver addressReceiver, Proxy proxy) Gets the OsidSession associated with the address notification service.
AddressNotificationSession	getAddressNotificationSessionForAddressBook(AddressReceiver addressReceiver, Id addressBookId, Proxy proxy) Gets the OsidSession associated with the address notification service for the given address book.
AddressQuerySession	getAddressQuerySession(Proxy proxy) Gets the OsidSession associated with the address query service.
AddressQuerySession	getAddressQuerySessionForAddressBook(Id addressBookId, Proxy proxy) Gets the OsidSession associated with the address query service for the given address book.
AddressSearchSession	getAddressSearchSession(Proxy proxy) Gets the OsidSession associated with the address search service.
AddressSearchSession	getAddressSearchSessionForAddressBook(Id addressBookId, Proxy proxy) Gets the OsidSession associated with the address search service for the given address book.
AddressSmartAddressBookSession	getAddressSmartAddressBookSession(Id addressBookId, Proxy proxy) Gets the session for managing dynamic address address books for the given address book.
ContactAddressBookAssignmentSession	getContactAddressBookAssignmentSession(Proxy proxy) Gets the session for assigning contact to address book mappings.
ContactAddressBookSession	getContactAddressBookSession(Proxy proxy) Gets the session for retrieving contact to address book mappings.
ContactAdminSession	getContactAdminSession(Proxy proxy) Gets the OsidSession associated with the contact administration service.
ContactAdminSession	getContactAdminSessionForAddressBook(Id addressId, Proxy proxy) Gets the OsidSession associated with the contact administration service for the given address book.
ContactBatchProxyManager	getContactBatchProxyManager() Gets the ContactBatchProxyManager.
ContactLookupSession	getContactLookupSession(Proxy proxy) Gets the OsidSession associated with the contact lookup service.
ContactLookupSession	getContactLookupSessionForAddressBook(Id addressId, Proxy proxy) Gets the OsidSession associated with the contact lookup service for the given address book.
ContactNotificationSession	getContactNotificationSession(ContactReceiver contactReceiver, Proxy proxy) Gets the OsidSession associated with the contact notification service.
ContactNotificationSession	getContactNotificationSessionForAddressBook(ContactReceiver contactReceiver, Id addressId, Proxy proxy) Gets the OsidSession associated with the contact notification service for the given address book.
ContactQuerySession	getContactQuerySession(Proxy proxy) Gets the OsidSession associated with the contact query service.
ContactQuerySession	getContactQuerySessionForAddressBook(Id addressId, Proxy proxy) Gets the OsidSession associated with the contact query service for the given address book.
ContactRulesProxyManager	getContactRulesProxyManager() Gets the ContactRulesProxyManager.
ContactSearchSession	getContactSearchSession(Proxy proxy) Gets the OsidSession associated with the contact search service.
ContactSearchSession	getContactSearchSessionForAddressBook(Id addressId, Proxy proxy) Gets the OsidSession associated with the contact search service for the given address book.
ContactSession	getContactSession(Proxy proxy) Gets the OsidSession associated with the contact service.
ContactSession	getContactSessionForAddressBook(Id addressId, Proxy proxy) Gets the OsidSession associated with the contact service for the given address book.
ContactSmartAddressBookSession	getContactSmartAddressBookSession(Id addressBookId, Proxy proxy) Gets the session associated with the contact smart address book for the given address book.

Methods inherited from interface org.osid.OsidProxyManager

changeBranch, initialize, rollbackService

Methods inherited from interface org.osid.binding.java.OsidProxyManager

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.contact.ContactProfile

getAddressBookRecordTypes, getAddressBookSearchRecordTypes, getAddressRecordTypes, getAddressSearchRecordTypes, getContactRecordTypes, getContactSearchRecordTypes, supportsAddressAddressBook, supportsAddressAddressBookAssignment, supportsAddressAdmin, supportsAddressBookAdmin, supportsAddressBookHierarchy, supportsAddressBookHierarchyDesign, supportsAddressBookLookup, supportsAddressBookNotification, supportsAddressBookQuery, supportsAddressBookRecordType, supportsAddressBookSearch, supportsAddressBookSearchRecordType, supportsAddressLookup, supportsAddressNotification, supportsAddressQuery, supportsAddressRecordType, supportsAddressSearch, supportsAddressSearchRecordType, supportsAddressSmartAddressBook, supportsContact, supportsContactAddressBook, supportsContactAddressBookAssignment, supportsContactAdmin, supportsContactBatch, supportsContactLookup, supportsContactNotification, supportsContactQuery, supportsContactRecordType, supportsContactRules, supportsContactSearch, supportsContactSearchRecordType, supportsContactSmartAddressBook, supportsVisibleFederation

Methods inherited from interface org.osid.OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getContactSession

ContactSession getContactSession(Proxy proxy)
                                 throws OperationFailedException

Gets the OsidSession associated with the contact service.

Parameters:

proxy - a proxy

Returns:

a ContactSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsContact() is false

Compliance:

optional - This method must be implemented if supportsContact() is true.

getContactSessionForAddressBook

ContactSession getContactSessionForAddressBook(Id addressId,
                                             Proxy proxy)
                                               throws NotFoundException,
                                                      OperationFailedException

Gets the OsidSession associated with the contact service for the given address book.

Parameters:

addressId - the Id of the Address

proxy - a proxy

Returns:

a ContactLookupSession

Throws:

NotFoundException - no Address found by the given Id

NullArgumentException - addressId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsContact() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsContact() and supportsVisibleFederation() are true

getContactLookupSession

ContactLookupSession getContactLookupSession(Proxy proxy)
                                             throws OperationFailedException

Gets the OsidSession associated with the contact lookup service.

Parameters:

proxy - a proxy

Returns:

a ContactLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsContactLookup() is false

Compliance:

optional - This method must be implemented if supportsContactLookup() is true.

getContactLookupSessionForAddressBook

ContactLookupSession getContactLookupSessionForAddressBook(Id addressId,
                                                         Proxy proxy)
                                                           throws NotFoundException,
                                                                  OperationFailedException

Gets the OsidSession associated with the contact lookup service for the given address book.

Parameters:

addressId - the Id of the Address

proxy - a proxy

Returns:

a ContactLookupSession

Throws:

NotFoundException - no Address found by the given Id

NullArgumentException - addressId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsContactLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsContactLookup() and supportsVisibleFederation() are true

getContactQuerySession

ContactQuerySession getContactQuerySession(Proxy proxy)
                                           throws OperationFailedException

Gets the OsidSession associated with the contact query service.

Parameters:

proxy - a proxy

Returns:

a ContactQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsContactQuery() is false

Compliance:

optional - This method must be implemented if supportsContactQuery() is true.

getContactQuerySessionForAddressBook

ContactQuerySession getContactQuerySessionForAddressBook(Id addressId,
                                                       Proxy proxy)
                                                         throws NotFoundException,
                                                                OperationFailedException

Gets the OsidSession associated with the contact query service for the given address book.

Parameters:

addressId - the Id of the Address

proxy - a proxy

Returns:

a ContactQuerySession

Throws:

NotFoundException - no Contact found by the given Id

NullArgumentException - addressId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsContactQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsContactQuery() and supportsVisibleFederation() are true

getContactSearchSession

ContactSearchSession getContactSearchSession(Proxy proxy)
                                             throws OperationFailedException

Gets the OsidSession associated with the contact search service.

Parameters:

proxy - a proxy

Returns:

a ContactSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsContactSearch() is false

Compliance:

optional - This method must be implemented if supportsContactSearch() is true.

getContactSearchSessionForAddressBook

ContactSearchSession getContactSearchSessionForAddressBook(Id addressId,
                                                         Proxy proxy)
                                                           throws NotFoundException,
                                                                  OperationFailedException

Gets the OsidSession associated with the contact search service for the given address book.

Parameters:

addressId - the Id of the Address

proxy - a proxy

Returns:

a ContactSearchSession

Throws:

NotFoundException - no Contact found by the given Id

NullArgumentException - addressId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsContactSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsContactSearch() and supportsVisibleFederation() are true

getContactAdminSession

ContactAdminSession getContactAdminSession(Proxy proxy)
                                           throws OperationFailedException

Gets the OsidSession associated with the contact administration service.

Parameters:

proxy - a proxy

Returns:

a ContactAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsContactAdmin() is false

Compliance:

optional - This method must be implemented if supportsContactAdmin() is true.

getContactAdminSessionForAddressBook

ContactAdminSession getContactAdminSessionForAddressBook(Id addressId,
                                                       Proxy proxy)
                                                         throws NotFoundException,
                                                                OperationFailedException

Gets the OsidSession associated with the contact administration service for the given address book.

Parameters:

addressId - the Id of the Address

proxy - a proxy

Returns:

a ContactAdminSession

Throws:

NotFoundException - no Contact found by the given Id

NullArgumentException - addressId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsContactAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsContactAdmin() and supportsVisibleFederation() are true

getContactNotificationSession

ContactNotificationSession getContactNotificationSession(ContactReceiver contactReceiver,
                                                       Proxy proxy)
                                                         throws OperationFailedException

Gets the OsidSession associated with the contact notification service.

Parameters:

contactReceiver - the receiver

proxy - a proxy

Returns:

a ContactNotificationSession

Throws:

NullArgumentException - contactReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsContactNotification() is false

Compliance:

optional - This method must be implemented if supportsContactNotification() is true.

getContactNotificationSessionForAddressBook

ContactNotificationSession getContactNotificationSessionForAddressBook(ContactReceiver contactReceiver,
                                                                     Id addressId,
                                                                     Proxy proxy)
                                                                       throws NotFoundException,
                                                                              OperationFailedException

Gets the OsidSession associated with the contact notification service for the given address book.

Parameters:

contactReceiver - the receiver

addressId - the Id of the Address

proxy - a proxy

Returns:

a ContactNotificationSession

Throws:

NotFoundException - no Contact found by the given Id

NullArgumentException - contactReceiver, addressId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsContactNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsContactNotification() and supportsVisibleFederation() are true

getContactAddressBookSession

ContactAddressBookSession getContactAddressBookSession(Proxy proxy)
                                                       throws OperationFailedException

Gets the session for retrieving contact to address book mappings.

Parameters:

proxy - a proxy

Returns:

a ContactAddressBookSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsContactAddressBook() is false

Compliance:

optional - This method must be implemented if supportsContactAddressBook() is true.

getContactAddressBookAssignmentSession

ContactAddressBookAssignmentSession getContactAddressBookAssignmentSession(Proxy proxy)
                                                                           throws OperationFailedException

Gets the session for assigning contact to address book mappings.

Parameters:

proxy - a proxy

Returns:

a ContactAddressBookAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsContactAddressBookAssignment() is false

Compliance:

optional - This method must be implemented if supportsContactAddressBookAssignment() is true.

getContactSmartAddressBookSession

ContactSmartAddressBookSession getContactSmartAddressBookSession(Id addressBookId,
                                                               Proxy proxy)
                                                                 throws NotFoundException,
                                                                        OperationFailedException

Gets the session associated with the contact smart address book for the given address book.

Parameters:

addressBookId - the Id of the contact book

proxy - a proxy

Returns:

a ContactSmartAddressBookSession

Throws:

NotFoundException - contactBookId not found

NullArgumentException - contactBookId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsContactSmartAddressBook() is false

Compliance:

optional - This method must be implemented if supportsContactSmartAddressBook() is true.

getAddressLookupSession

AddressLookupSession getAddressLookupSession(Proxy proxy)
                                             throws OperationFailedException

Gets the OsidSession associated with the address lookup service.

Parameters:

proxy - a proxy

Returns:

an AddressLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAddressLookup() is false

Compliance:

optional - This method must be implemented if supportsAddressLookup() is true.

getAddressLookupSessionForAddressBook

AddressLookupSession getAddressLookupSessionForAddressBook(Id addressBookId,
                                                         Proxy proxy)
                                                           throws NotFoundException,
                                                                  OperationFailedException

Gets the OsidSession associated with the address lookup service for the given address book.

Parameters:

addressBookId - the Id of the AddressBook

proxy - a proxy

Returns:

an AddressLookupSession

Throws:

NotFoundException - no AddressBook found by the given Id

NullArgumentException - addressBookId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAddressLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsAddressLookup() and supportsVisibleFederation() are true

getAddressQuerySession

AddressQuerySession getAddressQuerySession(Proxy proxy)
                                           throws OperationFailedException

Gets the OsidSession associated with the address query service.

Parameters:

proxy - a proxy

Returns:

an AddressQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAddressQuery() is false

Compliance:

optional - This method must be implemented if supportsAddressQuery() is true.

getAddressQuerySessionForAddressBook

AddressQuerySession getAddressQuerySessionForAddressBook(Id addressBookId,
                                                       Proxy proxy)
                                                         throws NotFoundException,
                                                                OperationFailedException

Gets the OsidSession associated with the address query service for the given address book.

Parameters:

addressBookId - the Id of the AddressBook

proxy - a proxy

Returns:

an AddressQuerySession

Throws:

NotFoundException - no Address found by the given Id

NullArgumentException - addressBookId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAddressQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsAddressQuery() and supportsVisibleFederation() are true

getAddressSearchSession

AddressSearchSession getAddressSearchSession(Proxy proxy)
                                             throws OperationFailedException

Gets the OsidSession associated with the address search service.

Parameters:

proxy - a proxy

Returns:

an AddressSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAddressSearch() is false

Compliance:

optional - This method must be implemented if supportsAddressSearch() is true.

getAddressSearchSessionForAddressBook

AddressSearchSession getAddressSearchSessionForAddressBook(Id addressBookId,
                                                         Proxy proxy)
                                                           throws NotFoundException,
                                                                  OperationFailedException

Gets the OsidSession associated with the address search service for the given address book.

Parameters:

addressBookId - the Id of the AddressBook

proxy - a proxy

Returns:

an AddressSearchSession

Throws:

NotFoundException - no Address found by the given Id

NullArgumentException - addressBookId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAddressSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsAddressSearch() and supportsVisibleFederation() are true

getAddressAdminSession

AddressAdminSession getAddressAdminSession(Proxy proxy)
                                           throws OperationFailedException

Gets the OsidSession associated with the address administrative service.

Parameters:

proxy - a proxy

Returns:

an AddressAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAddressAdmin() is false

Compliance:

optional - This method must be implemented if supportsAddressAdmin() is true.

getAddressAdminSessionForAddressBook

AddressAdminSession getAddressAdminSessionForAddressBook(Id addressBookId,
                                                       Proxy proxy)
                                                         throws NotFoundException,
                                                                OperationFailedException

Gets the OsidSession associated with the address administration service for the given address book.

Parameters:

addressBookId - the Id of the AddressBook

proxy - a proxy

Returns:

an AddressAdminSession

Throws:

NotFoundException - no Address found by the given Id

NullArgumentException - addressBookId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAddressAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsAddressAdmin() and supportsVisibleFederation() are true

getAddressNotificationSession

AddressNotificationSession getAddressNotificationSession(AddressReceiver addressReceiver,
                                                       Proxy proxy)
                                                         throws OperationFailedException

Gets the OsidSession associated with the address notification service.

Parameters:

addressReceiver - the receiver

proxy - a proxy

Returns:

an AddressNotificationSession

Throws:

NullArgumentException - addressReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAddressNotification() is false

Compliance:

optional - This method must be implemented if supportsAddressNotification() is true.

getAddressNotificationSessionForAddressBook

AddressNotificationSession getAddressNotificationSessionForAddressBook(AddressReceiver addressReceiver,
                                                                     Id addressBookId,
                                                                     Proxy proxy)
                                                                       throws NotFoundException,
                                                                              OperationFailedException

Gets the OsidSession associated with the address notification service for the given address book.

Parameters:

addressReceiver - the receiver

addressBookId - the Id of the AddressBook

proxy - a proxy

Returns:

an AddressNotificationSession

Throws:

NotFoundException - no Address found by the given Id

NullArgumentException - addressReceiver, addressBookId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAddressNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsAddressNotification() and supportsVisibleFederation() are true

getAddressAddressBookSession

AddressAddressBookSession getAddressAddressBookSession(Proxy proxy)
                                                       throws OperationFailedException

Gets the session for retrieving address to address book mappings.

Parameters:

proxy - a proxy

Returns:

an AddressAddressBookSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAddressAddressBook() is false

Compliance:

optional - This method must be implemented if supportsAddressAddressBook() is true.

getAddressAddressBookAssignmentSession

AddressAddressBookAssignmentSession getAddressAddressBookAssignmentSession(Proxy proxy)
                                                                           throws OperationFailedException

Gets the session for assigning address to address book mappings.

Parameters:

proxy - a proxy

Returns:

an AddressAddressBookAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAddressAddressBookAssignment() is false

Compliance:

optional - This method must be implemented if supportsAddressAddressBookAssignment() is true.

getAddressSmartAddressBookSession

AddressSmartAddressBookSession getAddressSmartAddressBookSession(Id addressBookId,
                                                               Proxy proxy)
                                                                 throws NotFoundException,
                                                                        OperationFailedException

Gets the session for managing dynamic address address books for the given address book.

Parameters:

addressBookId - the Id of an address book

proxy - a proxy

Returns:

an AddressSmartAddressBookSession

Throws:

NotFoundException - addressBookId is not found

NullArgumentException - addressBookId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAddressSmartAddressBook() is false

Compliance:

optional - This method must be implemented if supportsAddressSmartAddressBook() is true.

getAddressBookLookupSession

AddressBookLookupSession getAddressBookLookupSession(Proxy proxy)
                                                     throws OperationFailedException

Gets the OsidSession associated with the address book lookup service.

Parameters:

proxy - a proxy

Returns:

an AddressBookLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAddressBookLookup() is false

Compliance:

optional - This method must be implemented if supportsAddressBookLookup() is true.

getAddressBookQuerySession

AddressBookQuerySession getAddressBookQuerySession(Proxy proxy)
                                                   throws OperationFailedException

Gets the OsidSession associated with the address book query service.

Parameters:

proxy - a proxy

Returns:

an AddressBookQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAddressBookQuery() is false

Compliance:

optional - This method must be implemented if supportsAddressBookQuery() is true.

getAddressBookSearchSession

AddressBookSearchSession getAddressBookSearchSession(Proxy proxy)
                                                     throws OperationFailedException

Gets the OsidSession associated with the address book search service.

Parameters:

proxy - a proxy

Returns:

an AddressBookSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAddressBookSearch() is false

Compliance:

optional - This method must be implemented if supportsAddressBookSearch() is true.

getAddressBookAdminSession

AddressBookAdminSession getAddressBookAdminSession(Proxy proxy)
                                                   throws OperationFailedException

Gets the OsidSession associated with the address book administrative service.

Parameters:

proxy - a proxy

Returns:

an AddressBookAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAddressBookAdmin() is false

Compliance:

optional - This method must be implemented if supportsAddressBookAdmin() is true.

getAddressBookNotificationSession

AddressBookNotificationSession getAddressBookNotificationSession(AddressBookReceiver addressBookReceiver,
                                                               Proxy proxy)
                                                                 throws OperationFailedException

Gets the OsidSession associated with the address book notification service.

Parameters:

addressBookReceiver - the receiver

proxy - a proxy

Returns:

an AddressBookNotificationSession

Throws:

NullArgumentException - addressBookReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAddressBookNotification() is false

Compliance:

optional - This method must be implemented if supportsAddressBookNotification() is true.

getAddressBookHierarchySession

AddressBookHierarchySession getAddressBookHierarchySession(Proxy proxy)
                                                           throws OperationFailedException

Gets the OsidSession associated with the address book hierarchy service.

Parameters:

proxy - a proxy

Returns:

an AddressBookHierarchySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAddressBookHierarchy() is false

Compliance:

optional - This method must be implemented if supportsAddressBookHierarchy() is true.

getAddressBookHierarchyDesignSession

AddressBookHierarchyDesignSession getAddressBookHierarchyDesignSession(Proxy proxy)
                                                                       throws OperationFailedException

Gets the OsidSession associated with the address book hierarchy design service.

Parameters:

proxy - a proxy

Returns:

an AddressBookHierarchyDesignSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAddressBookHierarchyDesign() is false

Compliance:

optional - This method must be implemented if supportsAddressBookHierarchyDesign() is true.

getContactBatchProxyManager

ContactBatchProxyManager getContactBatchProxyManager()
                                                     throws OperationFailedException

Gets the ContactBatchProxyManager.

Returns:

a ContactBatchProxyManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsContactBatch() is false

Compliance:

optional - This method must be implemented if supportsContactBatch() is true.

getContactRulesProxyManager

ContactRulesProxyManager getContactRulesProxyManager()
                                                     throws OperationFailedException

Gets the ContactRulesProxyManager.

Returns:

a ContactRulesProxyManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsContactRules() is false

Compliance:

optional - This method must be implemented if supportsContactRules() is true.