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.
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.
|
changeBranch, initialize, rollbackService
close
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
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
ContactSession getContactSession() throws OperationFailedException
OsidSession
associated with the contact
service. ContactSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsContact()
is false
optional
- This method must be implemented if
supportsContact()
is true.
ContactSession getContactSessionForAddressBook(Id addressBookId) throws NotFoundException, OperationFailedException
OsidSession
associated with the contact
service for the given address book.addressBookId
- the Id
of the AddressBook
ContactSession
NotFoundException
- no AddressBook
found
by the given Id
NullArgumentException
- addressBookId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsContact()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsContact()
and
supportsVisibleFederation()
are true
ContactLookupSession getContactLookupSession() throws OperationFailedException
OsidSession
associated with the contact lookup
service. ContactLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsContactLookup()
is false
optional
- This method must be implemented if
supportsContactLookup()
is true.
ContactLookupSession getContactLookupSessionForAddressBook(Id addressBookId) throws NotFoundException, OperationFailedException
OsidSession
associated with the contact lookup
service for the given address book.addressBookId
- the Id
of the AddressBook
ContactLookupSession
NotFoundException
- no AddressBook
found
by the given Id
NullArgumentException
- addressBookId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsContactLookup()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsContactLookup()
and
supportsVisibleFederation()
are true
ContactQuerySession getContactQuerySession() throws OperationFailedException
OsidSession
associated with the contact query
service. ContactQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsContactQuery()
is false
optional
- This method must be implemented if
supportsContactQuery()
is true.
ContactQuerySession getContactQuerySessionForAddressBook(Id addressBookId) throws NotFoundException, OperationFailedException
OsidSession
associated with the contact query
service for the given address book.addressBookId
- the Id
of the AddressBook
ContactQuerySession
NotFoundException
- no AddressBook
found
by the given Id
NullArgumentException
- addressBookId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsContactQuery()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsContactQuery()
and
supportsVisibleFederation()
are true
ContactSearchSession getContactSearchSession() throws OperationFailedException
OsidSession
associated with the contact search
service. ContactSearchSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsContactSearch()
is false
optional
- This method must be implemented if
supportsContactSearch()
is true.
ContactSearchSession getContactSearchSessionForAddressBook(Id addressBookId) throws NotFoundException, OperationFailedException
OsidSession
associated with the contact search
service for the given address book.addressBookId
- the Id
of the AddressBook
ContactSearchSession
NotFoundException
- no AddressBook
found
by the given Id
NullArgumentException
- addressBookId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsContactSearch()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsContactSearch()
and
supportsVisibleFederation()
are true
ContactAdminSession getContactAdminSession() throws OperationFailedException
OsidSession
associated with the contact
administration service. ContactAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsContactAdmin()
is false
optional
- This method must be implemented if
supportsContactAdmin()
is true.
ContactAdminSession getContactAdminSessionForAddressBook(Id addressBookId) throws NotFoundException, OperationFailedException
OsidSession
associated with the contact
administration service for the given address book.addressBookId
- the Id
of the AddressBook
ContactAdminSession
NotFoundException
- no AddressBook
found
by the given Id
NullArgumentException
- addressBookId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsContactAdmin()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsContactAdmin()
and
supportsVisibleFederation()
are true
ContactNotificationSession getContactNotificationSession(ContactReceiver contactReceiver) throws OperationFailedException
OsidSession
associated with the contact
notification service.contactReceiver
- the receiver ContactNotificationSession
NullArgumentException
- contactReceiver
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsContactNotification()
is false
optional
- This method must be implemented if
supportsContactNotification()
is true.
ContactNotificationSession getContactNotificationSessionForAddressBook(ContactReceiver contactReceiver, Id addressBookId) throws NotFoundException, OperationFailedException
OsidSession
associated with the contact
notification service for the given address book.contactReceiver
- the receiveraddressBookId
- the Id
of the AddressBook
ContactNotificationSession
NotFoundException
- no AddressBook
found
by the given Id
NullArgumentException
- contactReceiver
or addressBookId
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsContactNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsContactNotification()
and
supportsVisibleFederation()
are true
ContactAddressBookSession getContactAddressBookSession() throws OperationFailedException
ContactAddressBookSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsContactAddressBook()
is false
optional
- This method must be implemented if
supportsContactAddressBook()
is true.
ContactAddressBookAssignmentSession getContactAddressBookAssignmentSession() throws OperationFailedException
ContactAddressBookAssignmentSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsContactAddressBookAssignment()
is false
optional
- This method must be implemented if
supportsContactAddressBookAssignment()
is
true.
ContactSmartAddressBookSession getContactSmartAddressBookSession(Id addressBookId) throws NotFoundException, OperationFailedException
addressBookId
- the Id
of the contact book ContactSmartAddressBookSession
NotFoundException
- contactBookId
not
foundNullArgumentException
- contactBookId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsContactSmartAddressBook()
is false
optional
- This method must be implemented if
supportsContactSmartAddressBook()
is true.
AddressLookupSession getAddressLookupSession() throws OperationFailedException
OsidSession
associated with the address lookup
service. AddressLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsAddressLookup()
is false
optional
- This method must be implemented if
supportsAddressLookup()
is true.
AddressLookupSession getAddressLookupSessionForAddressBook(Id addressBookId) throws NotFoundException, OperationFailedException
OsidSession
associated with the address lookup
service for the given address book.addressBookId
- the Id
of the Address
AddressLookupSession
NotFoundException
- no AddressBook
found
by the given Id
NullArgumentException
- addressBookId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsAddressLookup()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsAddressLookup()
and
supportsVisibleFederation()
are true
AddressQuerySession getAddressQuerySession() throws OperationFailedException
OsidSession
associated with the address query
service. AddressQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsAddressQuery()
is false
optional
- This method must be implemented if
supportsAddressQuery()
is true.
AddressQuerySession getAddressQuerySessionForAddressBook(Id addressBookId) throws NotFoundException, OperationFailedException
OsidSession
associated with the address query
service for the given address book.addressBookId
- the Id
of the Address
AddressQuerySession
NotFoundException
- no AddressBook
found
by the given Id
NullArgumentException
- addressBookId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsAddressQuery()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsAddressQuery()
and
supportsVisibleFederation()
are true
AddressSearchSession getAddressSearchSession() throws OperationFailedException
OsidSession
associated with the address search
service. AddressSearchSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsAddressSearch()
is false
optional
- This method must be implemented if
supportsAddressSearch()
is true.
AddressSearchSession getAddressSearchSessionForAddressBook(Id addressBookId) throws NotFoundException, OperationFailedException
OsidSession
associated with the address search
service for the given address book.addressBookId
- the Id
of the Address
AddressSearchSession
NotFoundException
- no AddressBook
found
by the given Id
NullArgumentException
- addressBookId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsAddressSearch()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsAddressSearch()
and
supportsVisibleFederation()
are true
AddressAdminSession getAddressAdminSession() throws OperationFailedException
OsidSession
associated with the address
administrative service. AddressAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsAddressAdmin()
is false
optional
- This method must be implemented if
supportsAddressAdmin()
is true.
AddressAdminSession getAddressAdminSessionForAddressBook(Id addressBookId) throws NotFoundException, OperationFailedException
OsidSession
associated with the address
administrative service for the given address book.addressBookId
- the Id
of the Address
AddressAdminSession
NotFoundException
- no AddressBook
found
by the given Id
NullArgumentException
- addressBookId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsAddressAdmin()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsAddressAdmin()
and
supportsVisibleFederation()
are true
AddressNotificationSession getAddressNotificationSession(AddressReceiver addressReceiver) throws OperationFailedException
OsidSession
associated with the address
notification service.addressReceiver
- the receiver AddressNotificationSession
NullArgumentException
- addressReceiver
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAddressNotification()
is false
optional
- This method must be implemented if
supportsAddressNotification()
is true.
AddressNotificationSession getAddressNotificationSessionForAddressBook(AddressReceiver addressReceiver, Id addressBookId) throws NotFoundException, OperationFailedException
OsidSession
associated with the address
notification service for the given address book.addressReceiver
- the receiveraddressBookId
- the Id
of the AddressBook
AddressNotificationSession
NotFoundException
- no AddressBook
found
by the given Id
NullArgumentException
- addressReceiver
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAddressNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsAddressNotification()
and
supportsVisibleFederation()
are true
AddressAddressBookSession getAddressAddressBookSession() throws OperationFailedException
AddressAddressBookSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAddressAddressBook()
is false
optional
- This method must be implemented if
supportsAddressAddressBook()
is true.
AddressAddressBookAssignmentSession getAddressAddressBookAssignmentSession() throws OperationFailedException
AddressAddressBookAssignmentSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAddressAddressBookAssignment()
is false
optional
- This method must be implemented if
supportsAddressAddressBookAssignment()
is
true.
AddressSmartAddressBookSession getAddressSmartAddressBookSession(Id addressBookId) throws NotFoundException, OperationFailedException
addressBookId
- the Id
of the address book AddressSmartAddressBookSession
NotFoundException
- addressBookId
not
foundNullArgumentException
- addressBookId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAddressSmartAddressBook()
is false
optional
- This method must be implemented if
supportsAddressSmartAddressBook()
is true.
AddressBookLookupSession getAddressBookLookupSession() throws OperationFailedException
OsidSession
associated with the address book
lookup service. AddressBookLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAddressBookLookup()
is false
optional
- This method must be implemented if
supportsAddressBookLookup()
is true.
AddressBookQuerySession getAddressBookQuerySession() throws OperationFailedException
OsidSession
associated with the address book
query service. AddressBookQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAddressBookQuery()
is false
optional
- This method must be implemented if
supportsAddressBookQuery()
is true.
AddressBookSearchSession getAddressBookSearchSession() throws OperationFailedException
OsidSession
associated with the address book
search service. AddressBookSearchSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAddressBookSearch()
is false
optional
- This method must be implemented if
supportsAddressBookSearch()
is true.
AddressBookAdminSession getAddressBookAdminSession() throws OperationFailedException
OsidSession
associated with the address book
administrative service. AddressBookAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAddressBookAdmin()
is false
optional
- This method must be implemented if
supportsAddressBookAdmin()
is true.
AddressBookNotificationSession getAddressBookNotificationSession(AddressBookReceiver addressBookReceiver) throws OperationFailedException
OsidSession
associated with the address book
notification service.addressBookReceiver
- the receiver AddressBookNotificationSession
NullArgumentException
- addressBookReceiver
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAddressBookNotification()
is false
optional
- This method must be implemented if
supportsAddressBookNotification()
is true.
AddressBookHierarchySession getAddressBookHierarchySession() throws OperationFailedException
OsidSession
associated with the address book
hierarchy service. AddressBookHierarchySession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAddressBookHierarchy()
is false
optional
- This method must be implemented if
supportsAddressBookHierarchy()
is true.
AddressBookHierarchyDesignSession getAddressBookHierarchyDesignSession() throws OperationFailedException
OsidSession
associated with the address book
hierarchy design service. AddressBookHierarchyDesignSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAddressBookHierarchyDesign()
is false
optional
- This method must be implemented if
supportsAddressBookHierarchyDesign()
is
true.
ContactBatchManager getContactBatchManager() throws OperationFailedException
ContactBatchManager.
ContactBatchManager
OperationFailedException
- unable to complete requestUnimplementedException
- supportsContactBatch()
is false
optional
- This method must be implemented if
supportsContactBatch()
is true.
ContactRulesManager getContactRulesManager() throws OperationFailedException
ContactRulesManager.
ContactRulesManager
OperationFailedException
- unable to complete requestUnimplementedException
- supportsContactRules()
is false
optional
- This method must be implemented if
supportsContactRules()
is true.