com.ecircleag.webservices

Class Member

Object

EcmessengerEntity

User

Member

public class Member
extends User

Extends the user entity with the additional membership related information.

Note: The XMLized form is compatible with the user object. If a user xml is used for construction of a member, an error will be the result, becaus no group id is available in a user xml. But it will work vice versa: all information to set up a user object is available in a member xml.

Since:

09.09.2005

Version:

$Id$

Author:

Bob Schulze schulze@ecircle-ag.com

Field Summary

Fields

Modifier and Type	Field and Description
String	groupid
String	userid

Constructor Summary

Constructors

Constructor and Description
Member()

Method Summary

Modifier and Type	Method and Description
static String	buildMemberId(String userId, String groupid) Create a Memberid from the internal user and groupid.
static String	extractGroupId(String memberId)
static String	extractUserId(String memberId)
static Member	fromXML(String xml)
String	getGroupId()
String	getId() Any EcmessengerEntity has a unique ID within the system and a XML document.
String	getMemberAttribute(String name) Provide the value of the given member attribute.
HashMap<String,String>	getMemberAttributes()
String	getUserId()
Member	setMemberAttribute(String name, String value)

Methods inherited from class User

getAttribute, getAttributes, getCountryCode, getDob_dd, getDob_mm, getDob_yyyy, getEmail, getFaxnumber, getFirstName, getIdentifier, getLanguageCode, getLastName, getMobilenumber, getNickName, getPartnerId, getTitle, getZipCode, setAttribute, setCountryCode, setDob_dd, setDob_mm, setDob_yyyy, setEmail, setFaxnumber, setFirstName, setId, setIdentifier, setLanguageCode, setLastName, setMobilenumber, setNickName, setPartnerId, setTitle, setZipCode

Methods inherited from class EcmessengerEntity

setLoaded, toHTTP, toXML

Methods inherited from class Object

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

Field Detail

groupid

public String groupid

userid

public String userid

Constructor Detail

Member

public Member()

Method Detail

getId

@EntityProperty
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 User

Returns:

the id

extractUserId

public static String extractUserId(String memberId)

See Also:

buildMemberId(String, String)

extractGroupId

public static String extractGroupId(String memberId)

See Also:

buildMemberId(String, String)

buildMemberId

public static String buildMemberId(String userId,
                                   String groupid)

Create a Memberid from the internal user and groupid. Both Id's are concatenated with a 'g' in the middle: <userid>g<groupid>.

Parameters:

userId -

groupid -

getGroupId

public String getGroupId()

getUserId

public String getUserId()

getMemberAttribute

public String getMemberAttribute(String name)

Provide the value of the given member attribute. Note: Member Attributes can be loaded by xml file uploads 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)

getMemberAttributes

@EntityProperty(xmlName="memberattr")
 @Web(webName="grpattr")
public HashMap<String,String> getMemberAttributes()

setMemberAttribute

public Member setMemberAttribute(String name,
                                 String value)

fromXML

public static Member fromXML(String xml)
                      throws Exception

Throws:

Exception