|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
public interface ContactManager
Manager of contacts. Entry point for contact management.
Note: If the DATABASE service is not available, that is, if UCS is not connected,
you cannot get features associated with UCS, that is, this contact manager.
| Method Summary | |
|---|---|
java.lang.Integer |
countContacts(SearchContactTemplate searchTemplate)
Returns the number of contacts matching the search request. |
Contact |
createContact()
Creates a new Contact with no information. |
Contact |
createContact(java.util.Map values)
Creates and saves a new Contact with information. |
Contact |
createContact(java.lang.String title,
java.lang.String first_name,
java.lang.String last_name,
java.lang.String email_address,
java.lang.String phone_number)
Creates a new Contact with this information. |
SearchContactTemplate |
createSearchContactTemplate()
Creates an empty SearchContactTemplate instance. |
java.util.Collection |
findOrCreateContact(java.util.Map searchCreateParams)
Finds a collection of contact identifiers associated with these parameters or create a contact for these new parameters. |
java.util.Collection |
getAllContactAttributeMetaData()
Returns the Collection of all attributes types of a contact. |
Contact |
getContact(java.lang.String id)
Returns the Contact with this ID. |
Contact |
getContact(java.lang.String id,
java.util.Collection aCAMDCol)
Returns the Contact of this ID. |
ContactAttributeMetaData |
getContactAttributeMetaDataById(java.lang.String attributeName)
Gets the predefined ContactAttributeMetaData instance for
an existing attribute ID. |
ContactAttributeMetaData |
getContactAttributeMetaDataByName(java.lang.String attributeName)
Gets the predefined ContactAttributeMetaData instance for
an existing attribute. |
ContactAttributeMetaData |
getEmailAddressAttribute()
Gets the predefined ContactAttributeMetaData instance for
the EmailAddress attribute. |
ContactAttributeMetaData |
getFirstNameAttribute()
Gets the predefined ContactAttributeMetaData instance for
the FirstName attribute. |
ContactAttributeMetaData |
getLastNameAttribute()
Gets the predefined ContactAttributeMetaData instance for
the LastName attribute. |
ContactAttributeMetaData |
getPhoneNumberAttribute()
Gets the predefined ContactAttributeMetaData instance for
the PhoneNumber attribute. |
ContactAttributeMetaData |
getTitleAttribute()
Gets the predefined ContactAttributeMetaData instance for
the Title attribute. |
boolean |
isSearchPrimaryValueOnly()
Indicates whether the connected UCS searches on primary values only. |
java.util.Collection |
searchContact(SearchContactTemplate aSearchTemplate)
Returns all the contacts as a Collection of Contact. |
| Method Detail |
|---|
Contact createContact(java.lang.String title,
java.lang.String first_name,
java.lang.String last_name,
java.lang.String email_address,
java.lang.String phone_number)
throws RequestFailedException
Contact with this information.
title - a title like Dr., Mr., Mrs. Use getTitleAttribute() to get the list of configured titles.first_name - the first name of the contact.last_name - the last name of the contact.email_address - the primary e-mail address of the contact.phone_number - the primary phone number of the contact.
Contact.
InvalidParameterException - if the parameter is null or invalid.
DatabaseServiceException - if the database service is out of order.
RequestFailedException - if request cannot proceed.
Contact createContact()
throws RequestFailedException
Contact with no information.
Contact.
RequestFailedException - if request cannot proceed.
Contact createContact(java.util.Map values)
throws RequestFailedException
Contact with information.
values - Map of attribute names as ContactAttributeMetaData
with list of ContactAttributeValue instances.
Contact.
InvalidParameterException - if the parameter is null or invalid.
DatabaseServiceException - if the database service is out of order.
RequestFailedException - if request cannot proceed.
Contact getContact(java.lang.String id,
java.util.Collection aCAMDCol)
throws RequestFailedException
Contact of this ID. Returns
null if no Contact associated with
this ID could be found
id - the ID of the Contact to get.aCAMDCol - collection of ContactAttributeMetaData to retrieve. If
this parameter is null, returns the Contact with all the
contact attributes.
Contact with this ID, or null.
InvalidParameterException - if the parameter is null or invalid.
DatabaseServiceException - if the database service is out of order.
RequestFailedException - if the service cannot fulfill the request.
Contact getContact(java.lang.String id)
throws RequestFailedException
Contact with this ID. Returns
null if no Contact with this ID could
be found. Contact is empty.
id - the ID of the Contact to get.
Contact with this ID, or null.
InvalidParameterException - if the parameter is null or invalid.
DatabaseServiceException - if the database service is out of order.
RequestFailedException - if the service cannot fulfill the request.
java.lang.Integer countContacts(SearchContactTemplate searchTemplate)
throws RequestFailedException
searchTemplate - as a SearchContactTemplate
instance.
InvalidParameterException - if one parameter
is invalid.
DatabaseServiceException - if the database service
cannot fulfill the request.
RequestFailedException - if the service cannot fulfill the request.
java.util.Collection searchContact(SearchContactTemplate aSearchTemplate)
throws RequestFailedException
Collection of Contact. The contacts are sorted, and you may ask for a
slice within this list. You may also ask for the contacts whose
name contains a certain String.
BE CAREFUL: According to the search contact template, retrieved contacts may be partial sets (attributes) of real contacts in Contact Server. You must consider that this returned list of contacts is in read-only mode, if you want to handle contact (add, remove attributes), you must use getContact method that can give you a full contact (with all attributes).
aSearchTemplate - as a SearchContactTemplate
instance.
Collection of sorted Contact instances.
InvalidParameterException - if one of the parameters
is invalid.
DatabaseServiceException - if the database service
cannot fulfill the request.
RequestFailedException - if the service cannot fulfill the request.java.util.Collection getAllContactAttributeMetaData()
ContactAttributeMetaData instances.SearchContactTemplate createSearchContactTemplate()
SearchContactTemplate instance.
SearchContactTemplate instance.ContactAttributeMetaData getFirstNameAttribute()
ContactAttributeMetaData instance for
the FirstName attribute.
ContactAttributeMetaData instance for FirstName.ContactAttributeMetaData getTitleAttribute()
ContactAttributeMetaData instance for
the Title attribute.
ContactAttributeMetaData instance for Title.ContactAttributeMetaData getLastNameAttribute()
ContactAttributeMetaData instance for
the LastName attribute.
ContactAttributeMetaData instance for LastName.ContactAttributeMetaData getEmailAddressAttribute()
ContactAttributeMetaData instance for
the EmailAddress attribute.
ContactAttributeMetaData instance for EmailAddress.ContactAttributeMetaData getPhoneNumberAttribute()
ContactAttributeMetaData instance for
the PhoneNumber attribute.
ContactAttributeMetaData instance for PhoneNumber.ContactAttributeMetaData getContactAttributeMetaDataByName(java.lang.String attributeName)
ContactAttributeMetaData instance for
an existing attribute.
attributeName - the name of the attribute
ContactAttributeMetaData instance for this attributeName.ContactAttributeMetaData getContactAttributeMetaDataById(java.lang.String attributeName)
ContactAttributeMetaData instance for
an existing attribute ID.
attributeName - the name of the attribute.
ContactAttributeMetaData instance for this ID.
java.util.Collection findOrCreateContact(java.util.Map searchCreateParams)
throws RequestFailedException
searchCreateParams - a Map of string attribute name and string value for
searching and/or creating the Contact instance.
String instance or empty collection.
InvalidParameterException - if the parameter is null or invalid.
DatabaseServiceException - if the database service is out of order.
RequestFailedException - if the service cannot fulfill the request.boolean isSearchPrimaryValueOnly()
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||