com.jamasoftware.contour.ws.domain

Class WsUser

java.lang.Object

com.jamasoftware.contour.ws.domain.WsUser

public class WsUser
extends Object

This object represents a Contour User. A user is a unique Contour login. Each has their own license type assignment, groups, and permissions. The license type is configured by the Administrator and controls the type of access a user has to Contour.

Author:

Dylan

Constructor Summary

Constructors

Constructor and Description
WsUser() Creates an empty WsUser object.
WsUser(String firstName, String lastName, String email, String userName, String licenseType, Integer orgId) Creates a new WsUser object with the given first and last names, user name, password, email, license type and orgId.
WsUser(String firstName, String lastName, String email, String userName, String title, String location, String notes, String phone, String licenseType, Integer orgId) Creates a new WsUser object with the given values.

Method Summary

Methods

Modifier and Type	Method and Description
Boolean	getActivated() Is the user activated?
String	getEmail() Gets the user's e-mail address.
String	getFirstName() Gets the first name of the user.
String	getFullName() Gets the full name of the user.
Long	getId() Gets the id of the user.
String	getLastName() Gets the last name of the user.
String	getLicenseType() Gets the license type for the user.
String	getLocale() Gets the user's locale.
String	getLocation() Gets the user's location.
String	getNotes() Gets any notes associated with the user.
Integer	getOrgId() Gets the id of the organization that the user belongs to.
String	getPassword() Deprecated.
String	getPhone() Gets the user's phone number.
String	getTitle() Gets the user's title.
String	getUserName() Gets the user's username.
boolean	isLocked() Is the user locked?
void	setActivated(Boolean activated) Sets the activated value for the user.
void	setEmail(String email) Sets the user's e-mail address.
void	setFirstName(String firstName) Sets the first name of the user.
void	setFullName(String fullName) Sets the full name of the user.
void	setId(Long id) Sets the user id.
void	setLastName(String lastName) Sets the last name of the user.
void	setLicenseType(String licenseType) Sets the license type for the user.
void	setLocale(String locale) Sets the user's locale.
void	setLocation(String location) Sets the user's location.
void	setLocked(boolean locked) Set the locked value for the user.
void	setNotes(String notes) Sets notes associated with the user.
void	setOrgId(Integer orgId) Sets the id of the organization that the user belongs to.
void	setPassword(String password) Deprecated.
void	setPhone(String phone) Sets the user's phone number.
void	setTitle(String title) Sets the user's title.
void	setUserName(String userName) Sets the user's username.
String	toString() Gets a string representation of this user.

Methods inherited from class java.lang.Object

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

Constructor Detail

WsUser

public WsUser()

Creates an empty WsUser object.

WsUser

public WsUser(String firstName,
      String lastName,
      String email,
      String userName,
      String title,
      String location,
      String notes,
      String phone,
      String licenseType,
      Integer orgId)

Creates a new WsUser object with the given values.

Parameters:

firstName - the first name of the user

lastName - the last name of the user

email - the email of the user

userName - the username of the user

title - the title of the user (can be null)

location - where the user is located (can be null)

notes - any notes about the user (can be null)

phone - the phone number of the user (can be null)

licenseType - the licenseType of the user ("R" for Collaborator, "FC" for Floating Collaborator, "C" for Floating, "N" for Named, "V" for Reviewer, "FV" for Floating Reviewer)

orgId - id of the organization the user is in

WsUser

public WsUser(String firstName,
      String lastName,
      String email,
      String userName,
      String licenseType,
      Integer orgId)

Creates a new WsUser object with the given first and last names, user name, password, email, license type and orgId.

Parameters:

firstName - the first name of the user

lastName - the last name of the user

email - the email of the user

userName - the username of the user

licenseType - the licenseType of the user ("R" for Collaborator, "FC" for Floating Collaborator, "C" for Floating, "N" for Named, "V" for Reviewer, "FR" for Floating Reviewer)

orgId - id of the organization the user is in

Method Detail

getId

public Long getId()

Gets the id of the user.

Returns:

the id

setId

public void setId(Long id)

Sets the user id.

Parameters:

id - the id to set

getFullName

public String getFullName()

Gets the full name of the user.

Returns:

the fullName

setFullName

public void setFullName(String fullName)

Sets the full name of the user.

Parameters:

fullName - the fullName to set

getFirstName

public String getFirstName()

Gets the first name of the user.

Returns:

the firstName

setFirstName

public void setFirstName(String firstName)

Sets the first name of the user.

Parameters:

firstName - the first name

getLastName

public String getLastName()

Gets the last name of the user.

Returns:

the lastName

setLastName

public void setLastName(String lastName)

Sets the last name of the user.

Parameters:

lastName - the last name

getEmail

public String getEmail()

Gets the user's e-mail address.

Returns:

the email

setEmail

public void setEmail(String email)

Sets the user's e-mail address.

Parameters:

email - the email to set

getUserName

public String getUserName()

Gets the user's username.

Returns:

the userName

setUserName

public void setUserName(String userName)

Sets the user's username.

Parameters:

userName - the userName to set

getPassword

@Deprecated
public String getPassword()

Deprecated.

Gets the user's password.

Returns:

the password

setPassword

@Deprecated
public void setPassword(String password)

Deprecated.

Sets the user's password.

Parameters:

password - the password to set

isLocked

public boolean isLocked()

Is the user locked?

Returns:

whether or not the user is locked locked

setLocked

public void setLocked(boolean locked)

Set the locked value for the user.

Parameters:

locked - whether or not the user should be locked

getTitle

public String getTitle()

Gets the user's title.

Returns:

the title

setTitle

public void setTitle(String title)

Sets the user's title.

Parameters:

title - the title to set

getLocation

public String getLocation()

Gets the user's location.

Returns:

the location

setLocation

public void setLocation(String location)

Sets the user's location.

Parameters:

location - the location to set

getNotes

public String getNotes()

Gets any notes associated with the user.

Returns:

the notes

setNotes

public void setNotes(String notes)

Sets notes associated with the user.

Parameters:

notes - the notes to set

getPhone

public String getPhone()

Gets the user's phone number.

Returns:

the phone number

setPhone

public void setPhone(String phone)

Sets the user's phone number.

Parameters:

phone - the phone number to set

getLocale

public String getLocale()

Gets the user's locale.

Returns:

the locale

setLocale

public void setLocale(String locale)

Sets the user's locale.

Parameters:

locale - the locale to set

getActivated

public Boolean getActivated()

Is the user activated?

Returns:

whether or not the user is activated

setActivated

public void setActivated(Boolean activated)

Sets the activated value for the user.

Parameters:

activated - whether or not the user should be activated

getLicenseType

public String getLicenseType()

Gets the license type for the user. ("R" for Collaborator, "FC" for Floating Collaborator, "C" for Floating, "N" for Named, "V" for Reviewer, "FR" for Floating Reviewer).

Returns:

the license type

setLicenseType

public void setLicenseType(String licenseType)

Sets the license type for the user. ("R" for Collaborator, "FC" for Floating Collaborator, "C" for Floating, "N" for Named, "V" for Reviewer, "FR" for Floating Reviewer).

Parameters:

licenseType - the licenseType to set

getOrgId

public Integer getOrgId()

Gets the id of the organization that the user belongs to.

Returns:

organization id

setOrgId

public void setOrgId(Integer orgId)

Sets the id of the organization that the user belongs to.

Parameters:

orgId - the organization id

toString

public String toString()

Gets a string representation of this user.

Overrides:

toString in class Object

Returns:

String