com.taskadapter.redmineapi.bean

Class User

java.lang.Object

com.taskadapter.redmineapi.bean.User

All Implemented Interfaces:

Identifiable

public class User
extends java.lang.Object
implements Identifiable

Redmine's User.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.Integer	STATUS_ACTIVE
static java.lang.Integer	STATUS_LOCKED

Method Summary

Modifier and Type	Method and Description
void	addCustomField(CustomField customField) If there is a custom field with the same ID already present, the new field replaces the old one.
void	addCustomFields(java.util.Collection<CustomField> customFields) NOTE: The custom field(s) must have correct database ID set to be saved to Redmine.
void	addGroups(java.util.Collection<Group> groups)
void	addMemberships(java.util.Collection<Membership> memberships)
void	clearCustomFields()
boolean	equals(java.lang.Object o)
java.lang.String	getApiKey()
java.lang.Integer	getAuthSourceId() Deprecated.
java.util.Date	getCreatedOn()
java.lang.String	getCustomField(java.lang.String fieldName)
java.util.Collection<CustomField>	getCustomFields()
java.lang.String	getFirstName()
java.lang.String	getFullName()
java.util.Collection<Group>	getGroups()
java.lang.Integer	getId()
java.util.Date	getLastLoginOn()
java.lang.String	getLastName()
java.lang.String	getLogin()
java.lang.String	getMail() This field is empty when using issues.get(i).getAssignee().getMail()
java.util.Collection<Membership>	getMemberships()
java.lang.String	getPassword()
java.lang.Integer	getStatus() Returns the user status.
int	hashCode()
void	setApiKey(java.lang.String apiKey) Deprecated.
void	setAuthSourceId(java.lang.Integer authSource)
void	setCreatedOn(java.util.Date createdOn)
void	setFirstName(java.lang.String firstName)
void	setFullName(java.lang.String fullName) This is a BIG HACK just to workaround the crappy Redmine REST API limitation.
void	setLastLoginOn(java.util.Date lastLoginOn)
void	setLastName(java.lang.String lastName)
void	setLogin(java.lang.String login)
void	setMail(java.lang.String mail)
void	setPassword(java.lang.String password)
void	setStatus(java.lang.Integer status) Sets the user status.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

STATUS_LOCKED

public static final java.lang.Integer STATUS_LOCKED

STATUS_ACTIVE

public static final java.lang.Integer STATUS_ACTIVE

Method Detail

getId

public java.lang.Integer getId()

Specified by:

getId in interface Identifiable

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getLogin

public java.lang.String getLogin()

setLogin

public void setLogin(java.lang.String login)

getFirstName

public java.lang.String getFirstName()

setFirstName

public void setFirstName(java.lang.String firstName)

getLastName

public java.lang.String getLastName()

setLastName

public void setLastName(java.lang.String lastName)

getMail

public java.lang.String getMail()

This field is empty when using issues.get(i).getAssignee().getMail()

setMail

public void setMail(java.lang.String mail)

getCreatedOn

public java.util.Date getCreatedOn()

setCreatedOn

public void setCreatedOn(java.util.Date createdOn)

getLastLoginOn

public java.util.Date getLastLoginOn()

setLastLoginOn

public void setLastLoginOn(java.util.Date lastLoginOn)

getApiKey

public java.lang.String getApiKey()

setApiKey

@Deprecated
public void setApiKey(java.lang.String apiKey)

Deprecated.

APIKey property is read-only. This setter is only for serialization JSon. The value you set using this method will be ignored by the server.

getAuthSourceId

@Deprecated
public java.lang.Integer getAuthSourceId()

Deprecated.

This value is not returned by redmine on existing users.

Returns:

- The Authentication Source ID, if you set it on your own.

setAuthSourceId

public void setAuthSourceId(java.lang.Integer authSource)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getFullName

public java.lang.String getFullName()

Returns:

firstName + space + lastName

setFullName

public void setFullName(java.lang.String fullName)

This is a BIG HACK just to workaround the crappy Redmine REST API limitation. see http://www.redmine.org/issues/7487

getPassword

public java.lang.String getPassword()

setPassword

public void setPassword(java.lang.String password)

getCustomField

public java.lang.String getCustomField(java.lang.String fieldName)

Returns:

the value or NULL if the field is not found

getCustomFields

public java.util.Collection<CustomField> getCustomFields()

Returns:

Custom Fields, NEVER NULL.

clearCustomFields

public void clearCustomFields()

addCustomFields

public void addCustomFields(java.util.Collection<CustomField> customFields)

NOTE: The custom field(s) must have correct database ID set to be saved to Redmine. This is Redmine REST API's limitation. ID can be seen in database or in Redmine administration when editing the custom field (number is part of the URL!).

addCustomField

public void addCustomField(CustomField customField)

If there is a custom field with the same ID already present, the new field replaces the old one.

Parameters:

customField - the field to add.

getMemberships

public java.util.Collection<Membership> getMemberships()

addMemberships

public void addMemberships(java.util.Collection<Membership> memberships)

getGroups

public java.util.Collection<Group> getGroups()

addGroups

public void addGroups(java.util.Collection<Group> groups)

getStatus

public java.lang.Integer getStatus()

Returns the user status. As defined in Redmine:

• 1: status active (STATUS_ACTIVE)
• 3: status locked (STATUS_LOCKED)

Returns:

User status

setStatus

public void setStatus(java.lang.Integer status)

Sets the user status.

Parameters:

status - must be one of STATUS_ACTIVE or STATUS_LOCKED