ContactItem (SEHR Core)

java.lang.Object
- org.ifeth.sehr.core.objects.ContactItem

All Implemented Interfaces:

java.io.Serializable
```
public class ContactItem
extends java.lang.Object
implements java.io.Serializable
```
Item of the SEHRDataObject model to store an address book entry.
Definition: A SEHRDataObject item is defined as an object that holds information. An item can be stored in a top-level SEHRDataObject or in a DB record. For each item should exist a model (at least a viewer class) to handle the item (by convention named xyzItemHandler).
Note: This data bean (object) uses only Java standard libraries to keep it transferable (serializable) as an object and reusable by Java apps outside a SEHR environment. To reuse the entry in other environments the model (handler) implements transfer methods to/from vcard, LDAP, XML, entity-EJB (DB record) etc.

Lit.Refs.
- Specification document 'spec_contactitem'
- LDAP schema Core (RFC2256)
- LDAP schema InetOrgPerson (RFC2798)
See Also:

ContactItem, Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`DATASETOID` Context OID part (see OID specification).
`static java.lang.String`	`SRCOID` Full qualified OID of a ContactItem object managed by SEHR.
`static java.lang.String`	`XSLProcessing` The processing instruction for browsers of this object.

Constructor Summary

Constructors
Constructor and Description
`ContactItem()` Parameterless Constructor
`ContactItem(java.lang.Integer id, java.lang.String subject, java.lang.String lastname, java.lang.String firstname, java.lang.String email, java.lang.String ctYYYYMMDD)` Constructor for creating a ContactItem by given data including an id.
`ContactItem(java.lang.String surname, java.lang.String email)` Constructor which creates a full qualified item object including a unique ID and date of creation.
`ContactItem(java.lang.String lastname, java.lang.String firstname, java.lang.String email)` 2nd Constructor which creates a full qualified item object including a unique ID and date of creation

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`addRootOriginatorOID(java.lang.String oid)` Use this method to create the computed OID to make this data set unique.
`java.lang.String`	`getAccount()`
`java.lang.String`	`getAddressCity()`
`java.lang.String`	`getAddressCountry()`
`java.lang.String`	`getAddressCountryCode()`
`java.lang.String`	`getAddressExt()`
`java.lang.String`	`getAddressPOBox()`
`java.lang.String`	`getAddressState()`
`java.lang.String`	`getAddressStreet()`
`java.lang.String`	`getAddressZIP()`
`java.lang.String`	`getBody()`
`java.lang.String[]`	`getCategories()`
`java.util.Date`	`getChangedTime()`
`java.util.Date`	`getCreationTime()`
`java.lang.String`	`getEMailDisplayName()`
`java.lang.Integer`	`getEntryID()`
`java.lang.String`	`getFax()`
`java.lang.String`	`getFirstname()`
`java.lang.Integer`	`getItemID()`
`java.lang.String`	`getLastFirst()` Returns preformatted string of lastname and firstname.
`java.lang.String`	`getLastFirstMail()` Returns preformatted name and mail string
`java.lang.String`	`getMail()` Returns the mail address.
`java.lang.String`	`getMiddle()` Middle of the name (e.g.
`java.lang.String`	`getMobile()`
`java.lang.String`	`getOID()`
`java.lang.Integer`	`getParentID()` Returns the parent ID of the contact if any otherwise 'null'.
`java.lang.String`	`getPhone()`
`java.lang.String`	`getSubject()`
`java.lang.String`	`getSuffix()`
`java.lang.String`	`getSurname()` Returns the last name of the entry
`java.lang.String`	`getTitle()`
`java.lang.String`	`getUserDefined1()`
`java.lang.String`	`getUserDefined2()`
`boolean`	`isSaved()`
`void`	`setAccount(java.lang.String account)`
`void`	`setAddressCity(java.lang.String city)`
`void`	`setAddressCountry(java.lang.String country)`
`void`	`setAddressCountryCode(java.lang.String ccode)`
`void`	`setAddressExt(java.lang.String ext)`
`void`	`setAddressPOBox(java.lang.String addresspobox)`
`void`	`setAddressState(java.lang.String state)`
`void`	`setAddressStreet(java.lang.String street)`
`void`	`setAddressZIP(java.lang.String zip)`
`void`	`setBody(java.lang.String body)`
`void`	`setCategories(java.lang.String[] categories)`
`void`	`setChangedTime(java.util.Date d)`
`void`	`setCreationTime(java.util.Date d)`
`void`	`setEMailDisplayName(java.lang.String s)`
`void`	`setEntryID(java.lang.Integer id)`
`void`	`setFax(java.lang.String fax)`
`void`	`setFirstname(java.lang.String first)`
`boolean`	`setMail(java.lang.String mail)` Sets and verifies the mail address.
`void`	`setMiddle(java.lang.String middle)` Middle of the name (e.g.
`void`	`setMobile(java.lang.String mobile)`
`void`	`setParentID(int id)`
`void`	`setPhone(java.lang.String phone)`
`void`	`setSaved(boolean b)`
`void`	`setSubject(java.lang.String subject)`
`void`	`setSuffix(java.lang.String suffix)`
`void`	`setSurname(java.lang.String last)`
`void`	`setTitle(java.lang.String title)`
`void`	`setUserDefined1(java.lang.String s)`
`void`	`setUserDefined2(java.lang.String s)`
`java.lang.String`	`toString()` Converts the entry as a preformatted string

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - SRCOID
```
public static final java.lang.String SRCOID
```
    Full qualified OID of a ContactItem object managed by SEHR.
    This is a object defined by SEHR RFC
    
    See Also:
    
    Constant Field Values
  - DATASETOID
```
public static final java.lang.String DATASETOID
```
    Context OID part (see OID specification).
    RootOID.100(=SEHRRoot).0(=SEHRDataSet).10(=ContactItem);
    0=means standard SEHR core collection
    
    See Also:
    
    SEHR OID Presentation, Constant Field Values
  - XSLProcessing
```
public static final java.lang.String XSLProcessing
```
    The processing instruction for browsers of this object.
    Note for maintenance:
    It is important to keep the integrity by using synchronized versions of the XSL files. Watch the project site for releases!
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ContactItem
```
public ContactItem()
```
    Parameterless Constructor
  - ContactItem
```
public ContactItem(java.lang.String surname,
                   java.lang.String email)
```
    Constructor which creates a full qualified item object including a unique ID and date of creation.
    
    Parameters:
    
    surname - The surname
    
    email - The mail address
  - ContactItem
```
public ContactItem(java.lang.String lastname,
                   java.lang.String firstname,
                   java.lang.String email)
```
    2nd Constructor which creates a full qualified item object including a unique ID and date of creation
    
    Parameters:
    
    lastname - The lastname
    
    firstname - The firstname
    
    email - The mail address
  - ContactItem
```
public ContactItem(java.lang.Integer id,
                   java.lang.String subject,
                   java.lang.String lastname,
                   java.lang.String firstname,
                   java.lang.String email,
                   java.lang.String ctYYYYMMDD)
```
    Constructor for creating a ContactItem by given data including an id.
    
    Parameters:
    
    id - e.g. a daabase record id
    
    subject - The display name in lists etc.
    
    lastname - The lastname of the person
    
    firstname - The firstname of the person
    
    email - The mail address
    
    ctYYYYMMDD - stamp of creation date time
- Method Detail
  - isSaved
```
public boolean isSaved()
```
  - setSaved
```
public void setSaved(boolean b)
```
  - getEntryID
```
public java.lang.Integer getEntryID()
```
  - setEntryID
```
public void setEntryID(java.lang.Integer id)
```
  - getParentID
```
public java.lang.Integer getParentID()
```
    Returns the parent ID of the contact if any otherwise 'null'.
    The reference attribute is 'ItemID'!
    
    Returns:
    
    parentID The parent ID of this item belongs to
  - setParentID
```
public void setParentID(int id)
```
  - getSurname
```
public final java.lang.String getSurname()
```
    Returns the last name of the entry
    
    Returns:
    
    String_LastName
  - setSurname
```
public void setSurname(java.lang.String last)
```
  - getFirstname
```
public java.lang.String getFirstname()
```
  - setFirstname
```
public void setFirstname(java.lang.String first)
```
  - getMiddle
```
public java.lang.String getMiddle()
```
    Middle of the name (e.g. 'van')
    
    Returns:
    
    the middle
  - setMiddle
```
public void setMiddle(java.lang.String middle)
```
    Middle of the name (e.g. 'van')
    
    Parameters:
    
    middle - the middle to set
  - getAccount
```
public java.lang.String getAccount()
```
  - setAccount
```
public void setAccount(java.lang.String account)
```
  - getAddressCity
```
public java.lang.String getAddressCity()
```
  - setAddressCity
```
public void setAddressCity(java.lang.String city)
```
  - getAddressCountry
```
public java.lang.String getAddressCountry()
```
  - setAddressCountry
```
public void setAddressCountry(java.lang.String country)
```
  - getAddressPOBox
```
public java.lang.String getAddressPOBox()
```
  - setAddressPOBox
```
public void setAddressPOBox(java.lang.String addresspobox)
```
  - getAddressState
```
public java.lang.String getAddressState()
```
  - setAddressState
```
public void setAddressState(java.lang.String state)
```
  - getAddressStreet
```
public java.lang.String getAddressStreet()
```
  - setAddressStreet
```
public void setAddressStreet(java.lang.String street)
```
  - getAddressZIP
```
public java.lang.String getAddressZIP()
```
  - setAddressZIP
```
public void setAddressZIP(java.lang.String zip)
```
  - getAddressCountryCode
```
public java.lang.String getAddressCountryCode()
```
  - setAddressCountryCode
```
public void setAddressCountryCode(java.lang.String ccode)
```
  - getCategories
```
public java.lang.String[] getCategories()
```
  - setCategories
```
public void setCategories(java.lang.String[] categories)
```
  - getChangedTime
```
public java.util.Date getChangedTime()
```
  - setChangedTime
```
public void setChangedTime(java.util.Date d)
```
  - getCreationTime
```
public java.util.Date getCreationTime()
```
  - setCreationTime
```
public void setCreationTime(java.util.Date d)
```
  - getItemID
```
public java.lang.Integer getItemID()
```
  - getMail
```
public java.lang.String getMail()
```
    Returns the mail address.
    e.g. 'doe@any.sehr.net'
    
    Returns:
    
    mailaddress The address of the contact entry
  - setMail
```
public boolean setMail(java.lang.String mail)
```
    Sets and verifies the mail address.
    e.g. 'doe@any.sehr.net'
    
    Parameters:
    
    mail - The address to check
    
    Returns:
    
    boolean true if syntax is ok
  - getEMailDisplayName
```
public java.lang.String getEMailDisplayName()
```
  - setEMailDisplayName
```
public void setEMailDisplayName(java.lang.String s)
```
  - getBody
```
public java.lang.String getBody()
```
  - setBody
```
public void setBody(java.lang.String body)
```
  - getSubject
```
public java.lang.String getSubject()
```
  - setSubject
```
public void setSubject(java.lang.String subject)
```
  - getUserDefined1
```
public java.lang.String getUserDefined1()
```
  - setUserDefined1
```
public void setUserDefined1(java.lang.String s)
```
  - getUserDefined2
```
public java.lang.String getUserDefined2()
```
  - setUserDefined2
```
public void setUserDefined2(java.lang.String s)
```
  - getTitle
```
public java.lang.String getTitle()
```
  - setTitle
```
public void setTitle(java.lang.String title)
```
  - getLastFirst
```
public java.lang.String getLastFirst()
```
    Returns preformatted string of lastname and firstname.
    
    Returns:
    
    "lastname, firstname"
  - getLastFirstMail
```
public java.lang.String getLastFirstMail()
```
    Returns preformatted name and mail string
    
    Returns:
    
    "name, firstname <email%gt;"
  - toString
```
public final java.lang.String toString()
```
    Converts the entry as a preformatted string
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    String - Preformatted entry as "name <mail>"
  - getSuffix
```
public java.lang.String getSuffix()
```
  - setSuffix
```
public void setSuffix(java.lang.String suffix)
```
  - getAddressExt
```
public java.lang.String getAddressExt()
```
  - setAddressExt
```
public void setAddressExt(java.lang.String ext)
```
  - getFax
```
public java.lang.String getFax()
```
  - setFax
```
public void setFax(java.lang.String fax)
```
  - getMobile
```
public java.lang.String getMobile()
```
  - setMobile
```
public void setMobile(java.lang.String mobile)
```
  - getPhone
```
public java.lang.String getPhone()
```
  - setPhone
```
public void setPhone(java.lang.String phone)
```
  - getOID
```
public java.lang.String getOID()
```
  - addRootOriginatorOID
```
public java.lang.String addRootOriginatorOID(java.lang.String oid)
```
    Use this method to create the computed OID to make this data set unique.
    e.g. for an OID argument:
    1.3.6.1.4.1.25889.101.0.276.0503201.1.04127439.2.00000017
    The computed OID will be:
    1.3.6.1.4.1.25889.101.0.276.0503201.1.04127439.2.00000017.100.0.10[.*]
    The interpretation is:
    This is a contact item (due to the ending 10) of a health care professional (.2.) in Germany(.276.) registered at zone 0503201 and center 04127439 with id (record id) #17. It is a standard SEHRDataSet because of the '100.0' of type contact (.10)
    
    Parameters:
    
    oid - a valid OID number (based on zone and center and/or user)
    
    Returns:
    
    generated OID using given argument

Class ContactItem

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SRCOID

DATASETOID

XSLProcessing

Constructor Detail

ContactItem

ContactItem

ContactItem

ContactItem

Method Detail

isSaved

setSaved

getEntryID

setEntryID

getParentID

setParentID

getSurname

setSurname

getFirstname

setFirstname

getMiddle

setMiddle

getAccount

setAccount

getAddressCity

setAddressCity

getAddressCountry

setAddressCountry

getAddressPOBox

setAddressPOBox

getAddressState

setAddressState

getAddressStreet

setAddressStreet

getAddressZIP

setAddressZIP

getAddressCountryCode

setAddressCountryCode

getCategories

setCategories

getChangedTime

setChangedTime

getCreationTime

setCreationTime

getItemID

getMail

setMail

getEMailDisplayName

setEMailDisplayName

getBody

setBody

getSubject

setSubject

getUserDefined1

setUserDefined1

getUserDefined2

setUserDefined2

getTitle

setTitle

getLastFirst

getLastFirstMail

toString

getSuffix

setSuffix

getAddressExt

setAddressExt

getFax

setFax

getMobile

setMobile

getPhone

setPhone

getOID

addRootOriginatorOID