Package com.collabnet.ce.webservices

Class CTFUser

java.lang.Object

com.collabnet.ce.webservices.CTFUser

All Implemented Interfaces:

ObjectWithTitle

public class CTFUser
extends Object
implements ObjectWithTitle

Author:

Kohsuke Kawaguchi

Field Summary

Fields

Modifier and Type	Field	Description
protected CollabNetApp	app
protected String	id

Method Summary

Modifier and Type	Method	Description
void	addTo(CTFGroup g)	Adds the user to the this group.
boolean	equals(Object o)
protected <T extends ObjectWithTitle> T	findByTitle(List<T> list, String title)	Convenience method for a subtype to find an item in a collection by its title.
String	getEmail()
String	getFullName()
Set<String>	getGroupNames()	Gets the group full names that this user belongs to.
CTFList<CTFGroup>	getGroups()
String	getId()
String	getLocale()
String	getStatus()
String	getTimeZone()
String	getTitle()	Alias for getUserName().
String	getUserName()
int	hashCode()
boolean	isRestrictedUser()
boolean	isSuperUser()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.collabnet.ce.webservices.ObjectWithTitle

getId

Field Detail

app

protected final CollabNetApp app

id

protected final String id

Method Detail

getUserName

public String getUserName()

getFullName

public String getFullName()

getEmail

public String getEmail()

getTitle

public String getTitle()

Alias for getUserName().

Specified by:

getTitle in interface ObjectWithTitle

getLocale

public String getLocale()
                 throws IOException

Throws:

IOException

getTimeZone

public String getTimeZone()
                   throws IOException

Throws:

IOException

isSuperUser

public boolean isSuperUser()
                    throws IOException

Throws:

IOException

isRestrictedUser

public boolean isRestrictedUser()
                         throws IOException

Throws:

IOException

getStatus

public String getStatus()
                 throws IOException

Throws:

IOException

getGroupNames

public Set<String> getGroupNames()
                          throws IOException

Gets the group full names that this user belongs to. This will only work if logged in as the user in question, or if the logged in user has superuser permissions.

Because of the incompleteness in the API, this method cannot readily return CTFGroups.

Throws:

IOException

getGroups

public CTFList<CTFGroup> getGroups()
                            throws IOException

Throws:

IOException

addTo

public void addTo(CTFGroup g)
           throws IOException

Adds the user to the this group.

Throws:

IOException

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getId

public String getId()

findByTitle

protected <T extends ObjectWithTitle> T findByTitle(List<T> list,
                                                    String title)

Convenience method for a subtype to find an item in a collection by its title.