com.funambol.common.pim.model.contact
Class Contact

java.lang.Object
  extended by com.funambol.common.pim.model.contact.Contact

public class Contact
extends java.lang.Object

An object representing a contact with all the information supported by Funambol it contains. This is the "foundational model" of a contact, used to exchange information about such items between server and connectors. It can also be used by clients.


Field Summary
static java.lang.String CLASS_CONFIDENTIAL
           
static java.lang.String CLASS_CUSTOM
           
static java.lang.String CLASS_PRIVATE
           
static java.lang.String CLASS_PUBLIC
           
static java.lang.Short SENSITIVITY_CONFIDENTIAL
           
static java.lang.Short SENSITIVITY_NORMAL
           
static java.lang.Short SENSITIVITY_PERSONAL
           
static java.lang.Short SENSITIVITY_PRIVATE
           
 
Constructor Summary
Contact()
          Creates an empty contact.
 
Method Summary
 void addNote(Note note)
          Adds a new note to the note list.
 void addXTag(XTag tag)
          Adds a new xtag to the xtag list
 BusinessDetail getBusinessDetail()
          Returns the business details of this contact.
 Property getCategories()
          Returns the categories this contact belongs to.
 java.lang.String getFolder()
          Returns the folder in which this contact's information are to be saved.
 java.lang.String getFreeBusy()
          Returns the free/busy status information for this contact.
 java.lang.Short getImportance()
          Returns the importance (priority) level of this contact.
 java.lang.String getLanguages()
          Returns the languages spoken by this contact.
 java.lang.String getMailer()
          Returns the mailer program name for this contact.
 java.lang.String getMileage()
          Returns the mileage information for this contact.
 Name getName()
          Returns the full name of this contact.
 java.util.List getNotes()
          Returns all the notes abouts this contact.
 PersonalDetail getPersonalDetail()
          Returns the personal details of this contact.
 java.lang.String getRevision()
          Returns the revision number of this contact.
 java.lang.Short getSensitivity()
          Returns the sensitivity of this contact's information (public, private etc.).
 java.lang.String getSubject()
          Returns the subject for this contact's information page.
 java.lang.String getTimezone()
          Returns the preferred time zone for this contact.
 java.lang.String getUid()
          Returns the unique ID (as defined by a client) of this contact.
 java.util.List getXTags()
          Returns the list of the custom properties of this contact.
 void setBusinessDetail(BusinessDetail businessDetail)
          Setter for property businessDetail.
 void setCategories(Property categories)
          Setter for property categories.
 void setFolder(java.lang.String folder)
          Setter for property folder.
 void setFreeBusy(java.lang.String freeBusy)
          Setter for property freeBusy.
 void setImportance(java.lang.Short importance)
          Setter for property importance (priority).
 void setLanguages(java.lang.String languages)
          Setter for property languages.
 void setMailer(java.lang.String mailer)
          Setter for property mailer.
 void setMileage(java.lang.String mileage)
          Setter for property mileage.
 void setName(Name name)
          Setter for property name.
 void setNotes(java.util.List notes)
          Setter for property notes.
 void setPersonalDetail(PersonalDetail personalDetail)
          Setter for property personalDetail.
 void setRevision(java.lang.String revision)
          Sets the revision number of this contact.
 void setSensitivity(java.lang.Short sensitivity)
          Setter for property sensitivity.
 void setSubject(java.lang.String subject)
          Setter for property subject.
 void setTimezone(java.lang.String timezone)
          Sets the preferred timezone for this contact.
 void setUid(java.lang.String uid)
          Sets the unique ID (as defined by a client) of this contact.
 void setXTags(java.util.List xTags)
          Setter for list xTags.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

SENSITIVITY_NORMAL

public static final java.lang.Short SENSITIVITY_NORMAL

SENSITIVITY_PERSONAL

public static final java.lang.Short SENSITIVITY_PERSONAL

SENSITIVITY_PRIVATE

public static final java.lang.Short SENSITIVITY_PRIVATE

SENSITIVITY_CONFIDENTIAL

public static final java.lang.Short SENSITIVITY_CONFIDENTIAL

CLASS_PUBLIC

public static final java.lang.String CLASS_PUBLIC
See Also:
Constant Field Values

CLASS_PRIVATE

public static final java.lang.String CLASS_PRIVATE
See Also:
Constant Field Values

CLASS_CONFIDENTIAL

public static final java.lang.String CLASS_CONFIDENTIAL
See Also:
Constant Field Values

CLASS_CUSTOM

public static final java.lang.String CLASS_CUSTOM
See Also:
Constant Field Values
Constructor Detail

Contact

public Contact()
Creates an empty contact.

Method Detail

getUid

public java.lang.String getUid()
Returns the unique ID (as defined by a client) of this contact.

Returns:
value of property uid

getTimezone

public java.lang.String getTimezone()
Returns the preferred time zone for this contact.

Returns:
value of property timezone

getNotes

public java.util.List getNotes()
Returns all the notes abouts this contact.

Returns:
a List that contains Note objects

setNotes

public void setNotes(java.util.List notes)
Setter for property notes.

Parameters:
notes - new value of property notes

addNote

public void addNote(Note note)
Adds a new note to the note list.

Parameters:
note - the new note

getXTags

public java.util.List getXTags()
Returns the list of the custom properties of this contact.

Returns:
a List containing XTag objects

setXTags

public void setXTags(java.util.List xTags)
Setter for list xTags.

Parameters:
xTags - a list containing XTag objects

getRevision

public java.lang.String getRevision()
Returns the revision number of this contact.

Returns:
value of property revision

getName

public Name getName()
Returns the full name of this contact.

Returns:
value of property name

getBusinessDetail

public BusinessDetail getBusinessDetail()
Returns the business details of this contact.

Returns:
the business details of this contact

getPersonalDetail

public PersonalDetail getPersonalDetail()
Returns the personal details of this contact.

Returns:
the personal details of this contact

setUid

public void setUid(java.lang.String uid)
Sets the unique ID (as defined by a client) of this contact.

Parameters:
uid - new value of property uid

setTimezone

public void setTimezone(java.lang.String timezone)
Sets the preferred timezone for this contact.

Parameters:
timezone - new value of property timezone

setRevision

public void setRevision(java.lang.String revision)
Sets the revision number of this contact.

Parameters:
revision - new value of property revision

getCategories

public Property getCategories()
Returns the categories this contact belongs to.

Returns:
value of property categories

setCategories

public void setCategories(Property categories)
Setter for property categories.

Parameters:
categories - new value of property categories.

getLanguages

public java.lang.String getLanguages()
Returns the languages spoken by this contact.

Returns:
value of property languages

setLanguages

public void setLanguages(java.lang.String languages)
Setter for property languages.

Parameters:
languages - new value of property languages

setName

public void setName(Name name)
Setter for property name. Note that this should not be used to set just a Name's property. In such cases calling one of the setters within this.getName() is better.

Parameters:
name - new value of property name

setBusinessDetail

public void setBusinessDetail(BusinessDetail businessDetail)
Setter for property businessDetail. Note that this should not be used to set just a BusinessDetail's property. In such cases calling one of the setters within this.getBusinessDetail() is better.

Parameters:
businessDetail - new value of property businessDetail

setPersonalDetail

public void setPersonalDetail(PersonalDetail personalDetail)
Setter for property personalDetail. Note that this should not be used to set just a PersonalDetail's property. In such cases calling one of the setters within this.getPersonalDetail() is better.

Parameters:
personalDetail - new value of property personalDetail

getImportance

public java.lang.Short getImportance()
Returns the importance (priority) level of this contact.

Returns:
value of property importance

setImportance

public void setImportance(java.lang.Short importance)
Setter for property importance (priority).

Parameters:
importance - new value of property importance

getSensitivity

public java.lang.Short getSensitivity()
Returns the sensitivity of this contact's information (public, private etc.).

Returns:
value of property sensitivity

setSensitivity

public void setSensitivity(java.lang.Short sensitivity)
Setter for property sensitivity.

Parameters:
sensitivity - new value of property sensitivity

getSubject

public java.lang.String getSubject()
Returns the subject for this contact's information page.

Returns:
value of property subject

setSubject

public void setSubject(java.lang.String subject)
Setter for property subject.

Parameters:
subject - new value of property subject

getMileage

public java.lang.String getMileage()
Returns the mileage information for this contact.

Returns:
value of property mileage

setMileage

public void setMileage(java.lang.String mileage)
Setter for property mileage.

Parameters:
mileage - new value of property mileage

getFolder

public java.lang.String getFolder()
Returns the folder in which this contact's information are to be saved.

Returns:
value of property folder

setFolder

public void setFolder(java.lang.String folder)
Setter for property folder.

Parameters:
folder - new value of property folder

setFreeBusy

public void setFreeBusy(java.lang.String freeBusy)
Setter for property freeBusy.

Parameters:
freeBusy - new value of property freeBusy

getFreeBusy

public java.lang.String getFreeBusy()
Returns the free/busy status information for this contact.

Returns:
value of property freeBusy

setMailer

public void setMailer(java.lang.String mailer)
Setter for property mailer.

Parameters:
mailer - new value of property mailer

getMailer

public java.lang.String getMailer()
Returns the mailer program name for this contact.

Returns:
value of property mailer

addXTag

public void addXTag(XTag tag)
Adds a new xtag to the xtag list

Parameters:
tag - the new xtag


Copyright © 2001-2009 Funambol.