站内搜索: 请输入搜索关键词
当前页面: 在线文档首页 > JBOSS Portal 2.6 API 英文版文档

User - JBOSS Portal 2.6 API 英文版文档


org.jboss.portal.identity
Interface User

All Known Implementing Classes:
LDAPUserImpl, UserImpl

public interface User

A user.

Version:
$Revision: 5448 $
Author:
Julien Viet, Thomas Heute, Magesh Kumar Bojan

Field Summary
static java.lang.String INFO_USER_EMAIL_FAKE
           
static java.lang.String INFO_USER_EXTRA
           
static java.lang.String INFO_USER_HOMEPAGE
           
static java.lang.String INFO_USER_IM_AIM
           
static java.lang.String INFO_USER_IM_ICQ
           
static java.lang.String INFO_USER_IM_MSNM
           
static java.lang.String INFO_USER_IM_SKYPE
           
static java.lang.String INFO_USER_IM_YIM
           
static java.lang.String INFO_USER_INTERESTS
           
static java.lang.String INFO_USER_LAST_LOGIN_DATE
           
static java.lang.String INFO_USER_LOCALE
           
static java.lang.String INFO_USER_LOCATION
           
static java.lang.String INFO_USER_OCCUPATION
           
static java.lang.String INFO_USER_REGISTRATION_DATE
           
static java.lang.String INFO_USER_SECURITY_ANSWER
           
static java.lang.String INFO_USER_SECURITY_QUESTION
           
static java.lang.String INFO_USER_SIGNATURE
           
static java.lang.String INFO_USER_THEME
           
static java.lang.String INFO_USER_TIME_ZONE_OFFSET
           
static java.lang.String INFO_USER_VIEW_EMAIL_VIEW_REAL
           
 
Method Summary
 boolean getEnabled()
          Disable the user.
 java.lang.String getFakeEmail()
           
 java.lang.String getFamilyName()
          The family name.
 java.lang.String getGivenName()
          The given name (firstname).
 java.lang.Object getId()
          The user identifier.
 java.util.Date getLastVisitDate()
          Return the last time the user logged in or null if this date is not known.
 java.util.Locale getPreferredLocale()
          Return the user preferred locale.
 ProfileMap getProfile()
          Returns the user properties.
 java.lang.String getRealEmail()
           
 java.util.Date getRegistrationDate()
           
 java.lang.String getSignature()
          Returns the signature.
 java.lang.String getTheme()
          Return the theme set for this user as the app id of the Theme.
 java.lang.String getUserName()
          The user name.
 boolean getViewRealEmail()
           
 void setEnabled(boolean enable)
          Enable the user.
 void setFakeEmail(java.lang.String fakeEmail)
           
 void setFamilyName(java.lang.String familyName)
           
 void setGivenName(java.lang.String givenName)
           
 void setLastVisitDate(java.util.Date date)
          Set the last visit date on this user.
 void setPreferredLocale(java.util.Locale locale)
          Set the user preferred locale.
 void setRealEmail(java.lang.String realEmail)
           
 void setSignature(java.lang.String signature)
          Set the signature.
 void setTheme(java.lang.String themeId)
          Set the theme for this user.
 void setViewRealEmail(boolean viewRealEmail)
           
 void updatePassword(java.lang.String password)
          Set the password.
 boolean validatePassword(java.lang.String password)
          Return true if the password is valid.
 

Field Detail

INFO_USER_REGISTRATION_DATE

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

INFO_USER_HOMEPAGE

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

INFO_USER_TIME_ZONE_OFFSET

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

INFO_USER_THEME

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

INFO_USER_LOCATION

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

INFO_USER_OCCUPATION

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

INFO_USER_EXTRA

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

INFO_USER_SIGNATURE

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

INFO_USER_INTERESTS

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

INFO_USER_LOCALE

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

INFO_USER_IM_ICQ

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

INFO_USER_IM_AIM

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

INFO_USER_IM_MSNM

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

INFO_USER_IM_YIM

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

INFO_USER_IM_SKYPE

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

INFO_USER_SECURITY_QUESTION

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

INFO_USER_SECURITY_ANSWER

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

INFO_USER_EMAIL_FAKE

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

INFO_USER_VIEW_EMAIL_VIEW_REAL

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

INFO_USER_LAST_LOGIN_DATE

public static final java.lang.String INFO_USER_LAST_LOGIN_DATE
See Also:
Constant Field Values
Method Detail

getId

public java.lang.Object getId()
The user identifier.


getEnabled

public boolean getEnabled()
Disable the user.


setEnabled

public void setEnabled(boolean enable)
Enable the user.


updatePassword

public void updatePassword(java.lang.String password)
Set the password.


validatePassword

public boolean validatePassword(java.lang.String password)
Return true if the password is valid.


getProfile

public ProfileMap getProfile()
Returns the user properties.


getUserName

public java.lang.String getUserName()
The user name.


getGivenName

public java.lang.String getGivenName()
The given name (firstname).


setGivenName

public void setGivenName(java.lang.String givenName)

getFamilyName

public java.lang.String getFamilyName()
The family name.


setFamilyName

public void setFamilyName(java.lang.String familyName)

getRealEmail

public java.lang.String getRealEmail()

setRealEmail

public void setRealEmail(java.lang.String realEmail)

getFakeEmail

public java.lang.String getFakeEmail()

setFakeEmail

public void setFakeEmail(java.lang.String fakeEmail)

getRegistrationDate

public java.util.Date getRegistrationDate()

getViewRealEmail

public boolean getViewRealEmail()

setViewRealEmail

public void setViewRealEmail(boolean viewRealEmail)

getPreferredLocale

public java.util.Locale getPreferredLocale()
Return the user preferred locale.


setPreferredLocale

public void setPreferredLocale(java.util.Locale locale)
Set the user preferred locale.


getSignature

public java.lang.String getSignature()
Returns the signature.


setSignature

public void setSignature(java.lang.String signature)
Set the signature.


getLastVisitDate

public java.util.Date getLastVisitDate()
Return the last time the user logged in or null if this date is not known.


setLastVisitDate

public void setLastVisitDate(java.util.Date date)
Set the last visit date on this user.


getTheme

public java.lang.String getTheme()
Return the theme set for this user as the app id of the Theme.


setTheme

public void setTheme(java.lang.String themeId)
Set the theme for this user.