org.osid.contact

Interface ContactManager

All Superinterfaces:

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

public interface ContactManager
extends OsidManager, ContactProfile

The contact manager provides access to contact sessions and provides interoperability tests for various aspects of this service. 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() Gets the session for assigning address to address book mappings.
AddressAddressBookSession	getAddressAddressBookSession() Gets the session for retrieving address to address book mappings.
AddressAdminSession	getAddressAdminSession() Gets the OsidSession associated with the address administrative service.
AddressAdminSession	getAddressAdminSessionForAddressBook(Id addressBookId) Gets the OsidSession associated with the address administrative service for the given address book.
AddressBookAdminSession	getAddressBookAdminSession() Gets the OsidSession associated with the address book administrative service.
AddressBookHierarchyDesignSession	getAddressBookHierarchyDesignSession() Gets the OsidSession associated with the address book hierarchy design service.
AddressBookHierarchySession	getAddressBookHierarchySession() Gets the OsidSession associated with the address book hierarchy service.
AddressBookLookupSession	getAddressBookLookupSession() Gets the OsidSession associated with the address book lookup service.
AddressBookNotificationSession	getAddressBookNotificationSession(AddressBookReceiver addressBookReceiver) Gets the OsidSession associated with the address book notification service.
AddressBookQuerySession	getAddressBookQuerySession() Gets the OsidSession associated with the address book query service.
AddressBookSearchSession	getAddressBookSearchSession() Gets the OsidSession associated with the address book search service.
AddressLookupSession	getAddressLookupSession() Gets the OsidSession associated with the address lookup service.
AddressLookupSession	getAddressLookupSessionForAddressBook(Id addressBookId) Gets the OsidSession associated with the address lookup service for the given address book.
AddressNotificationSession	getAddressNotificationSession(AddressReceiver addressReceiver) Gets the OsidSession associated with the address notification service.
AddressNotificationSession	getAddressNotificationSessionForAddressBook(AddressReceiver addressReceiver, Id addressBookId) Gets the OsidSession associated with the address notification service for the given address book.
AddressQuerySession	getAddressQuerySession() Gets the OsidSession associated with the address query service.
AddressQuerySession	getAddressQuerySessionForAddressBook(Id addressBookId) Gets the OsidSession associated with the address query service for the given address book.
AddressSearchSession	getAddressSearchSession() Gets the OsidSession associated with the address search service.
AddressSearchSession	getAddressSearchSessionForAddressBook(Id addressBookId) Gets the OsidSession associated with the address search service for the given address book.
AddressSmartAddressBookSession	getAddressSmartAddressBookSession(Id addressBookId) Gets the session associated with the address smart address book for the given address book.
ContactAddressBookAssignmentSession	getContactAddressBookAssignmentSession() Gets the session for assigning contact to address book mappings.
ContactAddressBookSession	getContactAddressBookSession() Gets the session for retrieving contact to address book mappings.
ContactAdminSession	getContactAdminSession() Gets the OsidSession associated with the contact administration service.
ContactAdminSession	getContactAdminSessionForAddressBook(Id addressBookId) Gets the OsidSession associated with the contact administration service for the given address book.
ContactBatchManager	getContactBatchManager() Gets the ContactBatchManager.
ContactLookupSession	getContactLookupSession() Gets the OsidSession associated with the contact lookup service.
ContactLookupSession	getContactLookupSessionForAddressBook(Id addressBookId) Gets the OsidSession associated with the contact lookup service for the given address book.
ContactNotificationSession	getContactNotificationSession(ContactReceiver contactReceiver) Gets the OsidSession associated with the contact notification service.
ContactNotificationSession	getContactNotificationSessionForAddressBook(ContactReceiver contactReceiver, Id addressBookId) Gets the OsidSession associated with the contact notification service for the given address book.
ContactQuerySession	getContactQuerySession() Gets the OsidSession associated with the contact query service.
ContactQuerySession	getContactQuerySessionForAddressBook(Id addressBookId) Gets the OsidSession associated with the contact query service for the given address book.
ContactRulesManager	getContactRulesManager() Gets the ContactRulesManager.
ContactSearchSession	getContactSearchSession() Gets the OsidSession associated with the contact search service.
ContactSearchSession	getContactSearchSessionForAddressBook(Id addressBookId) Gets the OsidSession associated with the contact search service for the given address book.
ContactSession	getContactSession() Gets the OsidSession associated with the contact service.
ContactSession	getContactSessionForAddressBook(Id addressBookId) Gets the OsidSession associated with the contact service for the given address book.
ContactSmartAddressBookSession	getContactSmartAddressBookSession(Id addressBookId) Gets the session associated with the contact smart address book for the given address book.

Methods inherited from interface org.osid.OsidManager

changeBranch, initialize, rollbackService

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

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()
                                 throws OperationFailedException

Gets the OsidSession associated with the contact service.

Returns:

a ContactSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsContact() is false

Compliance:

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

getContactSessionForAddressBook

ContactSession getContactSessionForAddressBook(Id addressBookId)
                                               throws NotFoundException,
                                                      OperationFailedException

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

Parameters:

addressBookId - the Id of the AddressBook

Returns:

a ContactSession

Throws:

NotFoundException - no AddressBook found by the given Id

NullArgumentException - addressBookId 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()
                                             throws OperationFailedException

Gets the OsidSession associated with the contact lookup service.

Returns:

a ContactLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsContactLookup() is false

Compliance:

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

getContactLookupSessionForAddressBook

ContactLookupSession getContactLookupSessionForAddressBook(Id addressBookId)
                                                           throws NotFoundException,
                                                                  OperationFailedException

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

Parameters:

addressBookId - the Id of the AddressBook

Returns:

a ContactLookupSession

Throws:

NotFoundException - no AddressBook found by the given Id

NullArgumentException - addressBookId 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()
                                           throws OperationFailedException

Gets the OsidSession associated with the contact query service.

Returns:

a ContactQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsContactQuery() is false

Compliance:

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

getContactQuerySessionForAddressBook

ContactQuerySession getContactQuerySessionForAddressBook(Id addressBookId)
                                                         throws NotFoundException,
                                                                OperationFailedException

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

Parameters:

addressBookId - the Id of the AddressBook

Returns:

a ContactQuerySession

Throws:

NotFoundException - no AddressBook found by the given Id

NullArgumentException - addressBookId 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()
                                             throws OperationFailedException

Gets the OsidSession associated with the contact search service.

Returns:

a ContactSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsContactSearch() is false

Compliance:

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

getContactSearchSessionForAddressBook

ContactSearchSession getContactSearchSessionForAddressBook(Id addressBookId)
                                                           throws NotFoundException,
                                                                  OperationFailedException

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

Parameters:

addressBookId - the Id of the AddressBook

Returns:

a ContactSearchSession

Throws:

NotFoundException - no AddressBook found by the given Id

NullArgumentException - addressBookId 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()
                                           throws OperationFailedException

Gets the OsidSession associated with the contact administration service.

Returns:

a ContactAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsContactAdmin() is false

Compliance:

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

getContactAdminSessionForAddressBook

ContactAdminSession getContactAdminSessionForAddressBook(Id addressBookId)
                                                         throws NotFoundException,
                                                                OperationFailedException

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

Parameters:

addressBookId - the Id of the AddressBook

Returns:

a ContactAdminSession

Throws:

NotFoundException - no AddressBook found by the given Id

NullArgumentException - addressBookId 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)
                                                         throws OperationFailedException

Gets the OsidSession associated with the contact notification service.

Parameters:

contactReceiver - the receiver

Returns:

a ContactNotificationSession

Throws:

NullArgumentException - contactReceiver 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 addressBookId)
                                                                       throws NotFoundException,
                                                                              OperationFailedException

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

Parameters:

contactReceiver - the receiver

addressBookId - the Id of the AddressBook

Returns:

a ContactNotificationSession

Throws:

NotFoundException - no AddressBook found by the given Id

NullArgumentException - contactReceiver or addressBookId 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()
                                                       throws OperationFailedException

Gets the session for retrieving contact to address book mappings.

Returns:

a ContactAddressBookSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsContactAddressBook() is false

Compliance:

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

getContactAddressBookAssignmentSession

ContactAddressBookAssignmentSession getContactAddressBookAssignmentSession()
                                                                           throws OperationFailedException

Gets the session for assigning contact to address book mappings.

Returns:

a ContactAddressBookAssignmentSession

Throws:

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)
                                                                 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

Returns:

a ContactSmartAddressBookSession

Throws:

NotFoundException - contactBookId not found

NullArgumentException - contactBookId 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()
                                             throws OperationFailedException

Gets the OsidSession associated with the address lookup service.

Returns:

an AddressLookupSession

Throws:

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)
                                                           throws NotFoundException,
                                                                  OperationFailedException

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

Parameters:

addressBookId - the Id of the Address

Returns:

an AddressLookupSession

Throws:

NotFoundException - no AddressBook found by the given Id

NullArgumentException - addressBookId 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()
                                           throws OperationFailedException

Gets the OsidSession associated with the address query service.

Returns:

an AddressQuerySession

Throws:

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)
                                                         throws NotFoundException,
                                                                OperationFailedException

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

Parameters:

addressBookId - the Id of the Address

Returns:

an AddressQuerySession

Throws:

NotFoundException - no AddressBook found by the given Id

NullArgumentException - addressBookId 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()
                                             throws OperationFailedException

Gets the OsidSession associated with the address search service.

Returns:

an AddressSearchSession

Throws:

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)
                                                           throws NotFoundException,
                                                                  OperationFailedException

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

Parameters:

addressBookId - the Id of the Address

Returns:

an AddressSearchSession

Throws:

NotFoundException - no AddressBook found by the given Id

NullArgumentException - addressBookId 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()
                                           throws OperationFailedException

Gets the OsidSession associated with the address administrative service.

Returns:

an AddressAdminSession

Throws:

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)
                                                         throws NotFoundException,
                                                                OperationFailedException

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

Parameters:

addressBookId - the Id of the Address

Returns:

an AddressAdminSession

Throws:

NotFoundException - no AddressBook found by the given Id

NullArgumentException - addressBookId 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)
                                                         throws OperationFailedException

Gets the OsidSession associated with the address notification service.

Parameters:

addressReceiver - the receiver

Returns:

an AddressNotificationSession

Throws:

NullArgumentException - addressReceiver 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)
                                                                       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

Returns:

an AddressNotificationSession

Throws:

NotFoundException - no AddressBook found by the given Id

NullArgumentException - addressReceiver 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()
                                                       throws OperationFailedException

Gets the session for retrieving address to address book mappings.

Returns:

an AddressAddressBookSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAddressAddressBook() is false

Compliance:

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

getAddressAddressBookAssignmentSession

AddressAddressBookAssignmentSession getAddressAddressBookAssignmentSession()
                                                                           throws OperationFailedException

Gets the session for assigning address to address book mappings.

Returns:

an AddressAddressBookAssignmentSession

Throws:

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)
                                                                 throws NotFoundException,
                                                                        OperationFailedException

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

Parameters:

addressBookId - the Id of the address book

Returns:

an AddressSmartAddressBookSession

Throws:

NotFoundException - addressBookId not found

NullArgumentException - addressBookId 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()
                                                     throws OperationFailedException

Gets the OsidSession associated with the address book lookup service.

Returns:

an AddressBookLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAddressBookLookup() is false

Compliance:

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

getAddressBookQuerySession

AddressBookQuerySession getAddressBookQuerySession()
                                                   throws OperationFailedException

Gets the OsidSession associated with the address book query service.

Returns:

an AddressBookQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAddressBookQuery() is false

Compliance:

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

getAddressBookSearchSession

AddressBookSearchSession getAddressBookSearchSession()
                                                     throws OperationFailedException

Gets the OsidSession associated with the address book search service.

Returns:

an AddressBookSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAddressBookSearch() is false

Compliance:

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

getAddressBookAdminSession

AddressBookAdminSession getAddressBookAdminSession()
                                                   throws OperationFailedException

Gets the OsidSession associated with the address book administrative service.

Returns:

an AddressBookAdminSession

Throws:

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)
                                                                 throws OperationFailedException

Gets the OsidSession associated with the address book notification service.

Parameters:

addressBookReceiver - the receiver

Returns:

an AddressBookNotificationSession

Throws:

NullArgumentException - addressBookReceiver 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()
                                                           throws OperationFailedException

Gets the OsidSession associated with the address book hierarchy service.

Returns:

an AddressBookHierarchySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAddressBookHierarchy() is false

Compliance:

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

getAddressBookHierarchyDesignSession

AddressBookHierarchyDesignSession getAddressBookHierarchyDesignSession()
                                                                       throws OperationFailedException

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

Returns:

an AddressBookHierarchyDesignSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAddressBookHierarchyDesign() is false

Compliance:

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

getContactBatchManager

ContactBatchManager getContactBatchManager()
                                           throws OperationFailedException

Gets the ContactBatchManager.

Returns:

a ContactBatchManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsContactBatch() is false

Compliance:

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

getContactRulesManager

ContactRulesManager getContactRulesManager()
                                           throws OperationFailedException

Gets the ContactRulesManager.

Returns:

a ContactRulesManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsContactRules() is false

Compliance:

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