com.xpn.xwiki.user.api
Class XWikiUser

java.lang.Object
  com.xpn.xwiki.user.api.XWikiUser

public class XWikiUser
extends java.lang.Object

Constructor Summary

XWikiUser(java.lang.String user)

XWikiUser(java.lang.String user, boolean main)

Method Summary

java.lang.String	getUser()
boolean	isMain()
boolean	isUserInGroup(java.lang.String groupName, XWikiContext context) Check if the user belongs to a group or not.
void	setMain(boolean main)
void	setUser(java.lang.String user)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

XWikiUser

public XWikiUser(java.lang.String user)

XWikiUser

public XWikiUser(java.lang.String user,
                 boolean main)

Method Detail

getUser

public java.lang.String getUser()

setUser

public void setUser(java.lang.String user)

isUserInGroup

public boolean isUserInGroup(java.lang.String groupName,
                             XWikiContext context)
                      throws XWikiException

Check if the user belongs to a group or not.

Parameters:

groupName - The group to check.

context - The current context.

Returns:

true if the user does belong to the specified group, false otherwise or if an exception occurs.

Throws:

XWikiException - If an error occurs when checking the groups.

Since:

Platform-1.3

isMain

public boolean isMain()

setMain

public void setMain(boolean main)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object