com.xpn.xwiki.user.api
Class XWikiUser

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

public class XWikiUser
extends Object


Constructor Summary
XWikiUser(String user)
           
XWikiUser(String user, boolean main)
           
 
Method Summary
 boolean equals(Object obj)
           
 String getUser()
           
 boolean isMain()
           
 boolean isUserInGroup(String groupName, XWikiContext context)
          Check if the user belongs to a group or not.
 void setMain(boolean main)
           
 void setUser(String user)
           
 String toString()
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

XWikiUser

public XWikiUser(String user)

XWikiUser

public XWikiUser(String user,
                 boolean main)
Method Detail

getUser

public String getUser()

setUser

public void setUser(String user)

isUserInGroup

public boolean isUserInGroup(String groupName,
                             XWikiContext context)
                      throws XWikiException
Check if the user belongs to a group or not. This method only check direct membership (no recursive checking) in the current wiki.

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 String toString()
Overrides:
toString in class Object

equals

public boolean equals(Object obj)
Overrides:
equals in class Object


Copyright © 2004–2014 XWiki. All rights reserved.