com.atlassian.crowd.plugin.rest.entity
Class UserEntity

java.lang.Object
  com.atlassian.crowd.plugin.rest.entity.UserEntity

All Implemented Interfaces:

NamedEntity

@Expander(value=UserEntityExpander.class)
public class UserEntity
extends Object
implements NamedEntity

Represents a User entity.

Since:

v2.1

Field Summary

static String

ATTRIBUTES_FIELD_NAME Name of the attributes field.

Constructor Summary

UserEntity(String name, String firstName, String lastName, String displayName, String emailAddress, PasswordEntity password, Boolean active, com.atlassian.plugins.rest.common.Link link)

Method Summary

MultiValuedAttributeEntityList	getAttributes()
String	getDisplayName()
String	getEmail()
String	getFirstName()
String	getLastName()
com.atlassian.plugins.rest.common.Link	getLink()
String	getName()
PasswordEntity	getPassword()
Boolean	isActive()
boolean	isExpanded() Does this object represent an expanded user, or does it only contain a username.
static UserEntity	newMinimalUserEntity(String name, String applicationName, com.atlassian.plugins.rest.common.Link link) Creates a UserEntity with the minimal amount of information required.
void	setActive(boolean active)
void	setAttributes(MultiValuedAttributeEntityList attributes)
void	setEmail(String email)
void	setLink(com.atlassian.plugins.rest.common.Link link)
void	setName(String name)
void	setPassword(PasswordEntity password)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

ATTRIBUTES_FIELD_NAME

public static final String ATTRIBUTES_FIELD_NAME

Name of the attributes field.

See Also:

Constant Field Values

Constructor Detail

UserEntity

public UserEntity(String name,
                  String firstName,
                  String lastName,
                  String displayName,
                  String emailAddress,
                  PasswordEntity password,
                  Boolean active,
                  com.atlassian.plugins.rest.common.Link link)

Method Detail

getDisplayName

public String getDisplayName()

getFirstName

public String getFirstName()

getLastName

public String getLastName()

setEmail

public void setEmail(String email)

getEmail

public String getEmail()

setPassword

public void setPassword(PasswordEntity password)

getPassword

public PasswordEntity getPassword()

setActive

public void setActive(boolean active)

isActive

public Boolean isActive()

setName

public void setName(String name)

getName

public String getName()

Specified by:

getName in interface NamedEntity

setAttributes

public void setAttributes(MultiValuedAttributeEntityList attributes)

getAttributes

public MultiValuedAttributeEntityList getAttributes()

newMinimalUserEntity

public static UserEntity newMinimalUserEntity(String name,
                                              String applicationName,
                                              com.atlassian.plugins.rest.common.Link link)

Creates a UserEntity with the minimal amount of information required.

Parameters:

name - Username.

applicationName - Name of the application.

link - Link to the canonical representation of the user. E.g. "/user?username=".

Returns:

UserEntity

toString

public String toString()

Overrides:

toString in class Object

setLink

public void setLink(com.atlassian.plugins.rest.common.Link link)

getLink

public com.atlassian.plugins.rest.common.Link getLink()

isExpanded

public boolean isExpanded()

Does this object represent an expanded user, or does it only contain a username.

Returns:

true if this object represents an expanded user