com.ecircleag.webservices

Class User

Object

EcmessengerEntity

User

Direct Known Subclasses:

Member

public class User
extends EcmessengerEntity

Helper Class to parse and create User Entities of the eC-Messenger System.

eC-Messenger distinguishes Users, Groups, Members, Messages and other entities.

Users have hard coded attributes (like setFirstname() or setLastname()) and custom attributes that are set up on a customers basis (see setAttribute()).

Since:

02.06.2005

Version:

$Id$

Author:

Bob Schulze schulze@ecircle-ag.com

Constructor Summary

Constructors

Constructor and Description
User()

Method Summary

Modifier and Type	Method and Description
static User	fromXML(String xml)
String	getAttribute(String name) Provide the value of the given user attribute.
HashMap<String,String>	getAttributes()
String	getCountryCode()
String	getDob_dd() Deprecated. use setAttribute("dob", "YYYY-MM-DD") instead to address the standard DOB attribute
String	getDob_mm() Deprecated. use setAttribute("dob", "YYYY-MM-DD") instead to address the standard DOB attribute
String	getDob_yyyy() Deprecated. use setAttribute("dob", "YYYY-MM-DD") instead to address the standard DOB attribute
String	getEmail()
String	getFaxnumber()
String	getFirstName()
String	getId() Any EcmessengerEntity has a unique ID within the system and a XML document.
String	getIdentifier()
String	getLanguageCode()
String	getLastName()
String	getMobilenumber()
String	getNickName()
int	getPartnerId()
byte	getTitle()
String	getZipCode()
User	setAttribute(String name, String value)
User	setCountryCode(String countryCode)
User	setDob_dd(String dateOfBirth)
User	setDob_mm(String dateOfBirth)
User	setDob_yyyy(String dateOfBirth)
User	setEmail(String eMail)
User	setFaxnumber(String faxnumber)
User	setFirstName(String firstName)
void	setId(String id)
User	setIdentifier(String identifier)
void	setLanguageCode(String languageCode)
User	setLastName(String lastName)
User	setMobilenumber(String mobilenumber)
User	setNickName(String nickName)
User	setPartnerId(int partnerId)
User	setTitle(byte title)
User	setZipCode(String zipCode)

Methods inherited from class EcmessengerEntity

setLoaded, toHTTP, toXML

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

User

public User()

Method Detail

setId

public void setId(String id)

getId

@EntityProperty
 @Web(webName="uid")
public String getId()

Description copied from class: EcmessengerEntity

Any EcmessengerEntity has a unique ID within the system and a XML document. It can only be assigned by the ecmessenger system.

Note, that a value of null does not get serialized by toXML().

Overrides:

getId in class EcmessengerEntity

Returns:

the id

getCountryCode

@EntityProperty
 @Web(webName="iso_country")
public String getCountryCode()

Returns:

ISO Country Code

setCountryCode

public User setCountryCode(String countryCode)

Parameters:

countryCode - per ISO todo

Returns:

The Object itself for setter chaining

getDob_dd

@EntityProperty
 @Web(webName="dob_dd")
public String getDob_dd()

Deprecated. use setAttribute("dob", "YYYY-MM-DD") instead to address the standard DOB attribute

Day og Birth

Returns:

the day part of the birthday

setDob_dd

public User setDob_dd(String dateOfBirth)

getDob_mm

@EntityProperty
 @Web(webName="dob_mm")
public String getDob_mm()

Deprecated. use setAttribute("dob", "YYYY-MM-DD") instead to address the standard DOB attribute

Month of Birth (0..11)

Returns:

the month part of the birthday

setDob_mm

public User setDob_mm(String dateOfBirth)

getDob_yyyy

@EntityProperty
 @Web(webName="dob_yyyy")
public String getDob_yyyy()

Deprecated. use setAttribute("dob", "YYYY-MM-DD") instead to address the standard DOB attribute

Year of Birth

Returns:

the four digit year part of the birthday

setDob_yyyy

public User setDob_yyyy(String dateOfBirth)

getEmail

@EntityProperty
 @Web(webName="uemail")
public String getEmail()

setEmail

public User setEmail(String eMail)

getFirstName

@EntityProperty
 @Web(webName="fnm")
public String getFirstName()

setFirstName

public User setFirstName(String firstName)

getLanguageCode

@EntityProperty
 @Web(webName="iso_lang")
public String getLanguageCode()

setLanguageCode

public void setLanguageCode(String languageCode)

getLastName

@EntityProperty
 @Web(webName="lnm")
public String getLastName()

setLastName

public User setLastName(String lastName)

getMobilenumber

@EntityProperty
 @Web(webName="mobilefullnum")
public String getMobilenumber()

setMobilenumber

public User setMobilenumber(String mobilenumber)

getFaxnumber

@EntityProperty
 @Web(webName="faxfullnum")
public String getFaxnumber()

setFaxnumber

public User setFaxnumber(String faxnumber)

getIdentifier

@EntityProperty
 @Web(webName="identifier")
public String getIdentifier()

setIdentifier

public User setIdentifier(String identifier)

getPartnerId

@EntityProperty
 @Web(webName="pid")
public int getPartnerId()

setPartnerId

public User setPartnerId(int partnerId)

getTitle

@EntityProperty
 @Web(webName="tlt")
public byte getTitle()

setTitle

public User setTitle(byte title)

getZipCode

@EntityProperty
 @Web(webName="zipcode")
public String getZipCode()

setZipCode

public User setZipCode(String zipCode)

getNickName

@EntityProperty
 @Web(webName="nickname")
public String getNickName()

setNickName

public User setNickName(String nickName)

setAttribute

public User setAttribute(String name,
                         String value)

getAttribute

public String getAttribute(String name)

Provide the value of the given user attribute. Note: User Attributes have to be configured separately in eC-Messenger.

Parameters:

name - The Attribute Name as visible in the user interface of eC-Messenger.

Returns:

the value or null, if such a attribute does not exist or is not set on that user. The Attribute is always returned as String. If it is originally in a different type, you can expect the XML String notation of that type (e.g. ISO8661 for timestamps)

getAttributes

@EntityProperty(xmlName="namedattr")
 @Web(webName="namedattr")
public HashMap<String,String> getAttributes()

fromXML

public static User fromXML(String xml)
                    throws Exception

Throws:

Exception