Package org.xwiki.user

Interface UserProperties

All Superinterfaces:

org.xwiki.configuration.ConfigurationSource

public interface UserProperties
extends org.xwiki.configuration.ConfigurationSource

Represents all the properties of an XWiki user. It can represent direct properites or inherited properties. Note that it's independent from where users are stored, and should remain that way, so that we can switch the user store in the future.

Since:

12.2

Version:

$Id: 9d6bd396954f8d6dbe5916cba06c50995eb059a9 $

Method Summary

Modifier and Type	Method	Description
boolean	displayHiddenDocuments()
Editor	getEditor()
javax.mail.internet.InternetAddress	getEmail()
String	getFirstName()
String	getLastName()
UserType	getType()
boolean	isActive()
boolean	isEmailChecked()
void	save()	Persist the various setXXX() calls made since the last call to this method.
void	setActive(boolean isActive)
void	setDisplayHiddenDocuments(boolean displayHiddenDocuments)
void	setEditor(Editor editor)
void	setEmail(javax.mail.internet.InternetAddress email)
void	setEmailChecked(boolean isEmailChecked)
void	setFirstName(String firstName)
void	setLastName(String lastName)
void	setType(UserType type)

Methods inherited from interface org.xwiki.configuration.ConfigurationSource

containsKey, getKeys, getProperty, getProperty, getProperty, getProperty, isEmpty, setProperties

Method Detail

displayHiddenDocuments

boolean displayHiddenDocuments()

Returns:

true if the user is configured to display hidden documents in the wiki

setDisplayHiddenDocuments

void setDisplayHiddenDocuments(boolean displayHiddenDocuments)

Parameters:

displayHiddenDocuments - see displayHiddenDocuments()

isActive

boolean isActive()

Returns:

true if the user is active in the wiki. An active user can log in.

setActive

void setActive(boolean isActive)

Parameters:

isActive - see isActive()

getFirstName

String getFirstName()

Returns:

the first name of the user or null if not set

setFirstName

void setFirstName(String firstName)

Parameters:

firstName - see getFirstName()

getLastName

String getLastName()

Returns:

the last name of the user or null if not set

setLastName

void setLastName(String lastName)

Parameters:

lastName - see getLastName()

getEmail

javax.mail.internet.InternetAddress getEmail()

Returns:

the email address of the user and null if not set

setEmail

void setEmail(javax.mail.internet.InternetAddress email)

Parameters:

email - see getEmail()

getType

UserType getType()

Returns:

the type of the user (simple user, advanced user)

See Also:

user profile

setType

void setType(UserType type)

Parameters:

type - see getType()

getEditor

Editor getEditor()

Returns:

the default editor to use when editing content for this user (text editor, wysiwyg editor)

setEditor

void setEditor(Editor editor)

Parameters:

editor - see getEditor()

isEmailChecked

boolean isEmailChecked()

Returns:

true if the user's email has been checked. In some configurations, users must have had their emails verified before they can access the wiki. Also, disabled users must have their emails checked to be able to view pages.

setEmailChecked

void setEmailChecked(boolean isEmailChecked)

Parameters:

isEmailChecked - see isEmailChecked()

save

void save()
   throws org.xwiki.configuration.ConfigurationSaveException

Persist the various setXXX() calls made since the last call to this method.

Throws:

org.xwiki.configuration.ConfigurationSaveException - in case of an error during the save