Interface ContactManager

All Superinterfaces:

AutoCloseable, Closeable, ContactProfile, OsidManager, 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

Modifier and Type	Method	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 Closeable

close

Methods inherited from interface 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

Modifier and Type	Method	Description
TypeList	getAddressBookRecordTypes()	Gets the supported AddressBook record types.
TypeList	getAddressBookSearchRecordTypes()	Gets the supported address book search record types.
TypeList	getAddressRecordTypes()	Gets the supported Address record types.
TypeList	getAddressSearchRecordTypes()	Gets the supported address search record types.
TypeList	getContactRecordTypes()	Gets the supported Contact record types.
TypeList	getContactSearchRecordTypes()	Gets the supported contact search record types.
boolean	supportsAddressAddressBook()	Tests if an address to address book lookup session is available.
boolean	supportsAddressAddressBookAssignment()	Tests if an address to address book assignment session is available.
boolean	supportsAddressAdmin()	Tests for the availability of an address administrative service for creating and deleting addresses.
boolean	supportsAddressBookAdmin()	Tests for the availability of an address book administrative service for creating and deleting address books.
boolean	supportsAddressBookHierarchy()	Tests for the availability of an address book hierarchy traversal service.
boolean	supportsAddressBookHierarchyDesign()	Tests for the availability of an address book hierarchy design service.
boolean	supportsAddressBookLookup()	Tests for the availability of an address book lookup service.
boolean	supportsAddressBookNotification()	Tests for the availability of an address book notification service.
boolean	supportsAddressBookQuery()	Tests if querying address books is available.
boolean	supportsAddressBookRecordType(Type addressBookRecordType)	Tests if the given AddressBook record type is supported.
boolean	supportsAddressBookSearch()	Tests if searching for address books is available.
boolean	supportsAddressBookSearchRecordType(Type addressBookSearchRecordType)	Tests if the given address book search record type is supported.
boolean	supportsAddressLookup()	Tests for the availability of an address lookup service.
boolean	supportsAddressNotification()	Tests for the availability of an address notification service.
boolean	supportsAddressQuery()	Tests if querying addresses is available.
boolean	supportsAddressRecordType(Type addressRecordType)	Tests if the given Address record type is supported.
boolean	supportsAddressSearch()	Tests if searching for addresses is available.
boolean	supportsAddressSearchRecordType(Type addressSearchRecordType)	Tests if the given address search record type is supported.
boolean	supportsAddressSmartAddressBook()	Tests if an address smart address book session is available.
boolean	supportsContact()	Tests for the availability of a contact service for getting available contacts for a resource.
boolean	supportsContactAddressBook()	Tests if a contact to address book lookup session is available.
boolean	supportsContactAddressBookAssignment()	Tests if a contact to address book assignment session is available.
boolean	supportsContactAdmin()	Tests if managing contacts is available.
boolean	supportsContactBatch()	Tests for the availability of a contact batch service.
boolean	supportsContactLookup()	Tests for the availability of a contact lookup service.
boolean	supportsContactNotification()	Tests if contact notification is available.
boolean	supportsContactQuery()	Tests if querying contacts is available.
boolean	supportsContactRecordType(Type contactRecordType)	Tests if the given Contact record type is supported.
boolean	supportsContactRules()	Tests for the availability of a contact rules service.
boolean	supportsContactSearch()	Tests if searching for contacts is available.
boolean	supportsContactSearchRecordType(Type contactSearchRecordType)	Tests if the given contact search record type is supported.
boolean	supportsContactSmartAddressBook()	Tests if a contact smart address book session is available.
boolean	supportsVisibleFederation()	Tests if any address federation is exposed.

Methods inherited from interface OsidManager

close

Modifier and Type	Method	Description
void	close()	Close this manager.

Methods inherited from interface OsidManager

changeBranch, initialize, rollbackService

Modifier and Type	Method	Description
void	changeBranch(Id branchId)	Changes the service branch.
void	initialize(OsidRuntimeManager runtime)	Initializes this manager.
JournalEntry	rollbackService(Date rollbackTime)	Rolls back this service to a point in time.

Methods inherited from interface OsidProfile

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

Modifier and Type	Method	Description
Branch	getBranch()	Gets this service branch.
Id	getBranchId()	Gets the Branch Id representing this service branch.
DisplayText	getDescription()	Gets a description of this service implementation.
DisplayText	getDisplayName()	Gets a display name for this service implementation.
Id	getId()	Gets an identifier for this service implementation.
LocaleList	getLocales()	Gets the locales supported in this service.
TypeList	getProxyRecordTypes()	Gets the proxy record Types supported in this service.
DateTime	getReleaseDate()	Gets the date this service implementation was released.
Version	getVersion()	Gets the version of this service implementation.
boolean	supportsJournalBranching()	Test for support of a journal branching service.
boolean	supportsJournalRollback()	Test for support of a journaling rollback service.
boolean	supportsOSIDVersion(Version version)	Test for support of an OSID specification version.
boolean	supportsProxyRecordType(Type proxyRecordType)	Test for support of a proxy type.

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Modifier and Type	Method	Description
AssetList	getBranding()	Gets a branding, such as an image or logo, expressed using the Asset interface.
IdList	getBrandingIds()	Gets the branding asset Ids .
DisplayText	getLicense()	Gets the terms of usage.
Resource	getProvider()	Gets the Resource representing the provider.
Id	getProviderId()	Gets the Id of the provider.

Method Details

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 {@code supportsContact()} is {@code 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 {@code supportsContact()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsContactLookup()} is {@code 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 {@code supportsContactLookup()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsContactQuery()} is {@code 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 {@code supportsContactQuery()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsContactSearch()} is {@code 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 {@code supportsContactSearch()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsContactAdmin()} is {@code 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 {@code supportsContactAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsContactNotification()} is {@code 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 {@code supportsContactNotification()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsContactAddressBook()} is {@code 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 {@code supportsContactAddressBookAssignment()} is {@code 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 {@code supportsContactSmartAddressBook()} is {@code 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 {@code supportsAddressLookup()} is {@code 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 {@code supportsAddressLookup()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsAddressQuery()} is {@code 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 {@code supportsAddressQuery()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsAddressSearch()} is {@code 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 {@code supportsAddressSearch()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsAddressAdmin()} is {@code 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 {@code supportsAddressAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsAddressNotification()} is {@code 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 {@code supportsAddressNotification()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsAddressAddressBook()} is {@code 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 {@code supportsAddressAddressBookAssignment()} is {@code 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 {@code supportsAddressSmartAddressBook()} is {@code 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 {@code supportsAddressBookLookup()} is {@code 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 {@code supportsAddressBookQuery()} is {@code 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 {@code supportsAddressBookSearch()} is {@code 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 {@code supportsAddressBookAdmin()} is {@code 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 {@code supportsAddressBookNotification()} is {@code 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 {@code supportsAddressBookHierarchy()} is {@code 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 {@code supportsAddressBookHierarchyDesign()} is {@code 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 {@code supportsContactBatch()} is {@code 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 {@code supportsContactRules()} is {@code true} .