org.exoplatform.services.organization

Interface UserProfile

public interface UserProfile

Created by The eXo Platform SAS
This is the interface for a UserProfile data model. The implementor should have an user map info in the implementation. The map should only accept the java.lang.String for the key and the value. Note that after the developer changes the user information in the user info map, he needs to call UserProfileHandler.saveUserProfile(UserProfile, boolean) to persist the change.

Author:

Tuan Nguyen

Level API:

Platform

Field Summary

Fields

Modifier and Type	Field and Description
static String[]	BUSINESE_INFO_KEYS The predefine attributes of the user businese info.
static String[]	HOME_INFO_KEYS The predefine attributes of the user home info.
static String[]	OTHER_KEYS The predefine attributes of the exoplatform.
static String[]	PERSONAL_INFO_KEYS The predefine attributes of the user personal info.

Method Summary

Methods

Modifier and Type	Method and Description
String	getAttribute(String attName)
Map<String,String>	getUserInfoMap()
String	getUserName()
void	setAttribute(String key, String value) Use this method to change or add a new attribute to the user info map.
void	setUserInfoMap(Map<String,String> map)
void	setUserName(String username) Deprecated. The third party developer should not used this method. We should pass the username to the UserProfileHandler.createUserProfileInstance(String) and set the username for the instance once only.

Field Detail

PERSONAL_INFO_KEYS

static final String[] PERSONAL_INFO_KEYS

The predefine attributes of the user personal info. Those attributes are define in the JSR 168 specification

HOME_INFO_KEYS

static final String[] HOME_INFO_KEYS

The predefine attributes of the user home info. Those attributes are define in the JSR 168 specification

BUSINESE_INFO_KEYS

static final String[] BUSINESE_INFO_KEYS

The predefine attributes of the user businese info. Those attributes are define in the JSR 168 specification

OTHER_KEYS

static final String[] OTHER_KEYS

The predefine attributes of the exoplatform. Those keys are currently used in the exo forum

Method Detail

getUserName

String getUserName()

Returns:

the username, the identifier of an user profile instance

setUserName

void setUserName(String username)

Deprecated. The third party developer should not used this method. We should pass the username to the UserProfileHandler.createUserProfileInstance(String) and set the username for the instance once only.

getUserInfoMap

Map<String,String> getUserInfoMap()

Returns:

The map that contains the user information. The map should only accept the java.lang.String for the key and the value.

setUserInfoMap

void setUserInfoMap(Map<String,String> map)

Parameters:

map - The map that contains the extra user information. The map should contains only the java.lang.String as the key and the value.

getAttribute

String getAttribute(String attName)

Parameters:

attName - The key name of an attribute in the user info map.

Returns:

null if no key is matched in the user info map or a String value.

setAttribute

void setAttribute(String key,
                String value)

Use this method to change or add a new attribute to the user info map.

Parameters:

key - The attribute name of the info

value - An info of the user.