CodeBeamer 5.4.0.1-RC API

com.intland.codebeamer.persistence.dto
Class UserDto

java.lang.Object
  extended by com.intland.codebeamer.persistence.dto.base.IdentifiableDto
      extended by com.intland.codebeamer.persistence.dto.base.NamedDto
          extended by com.intland.codebeamer.persistence.dto.UserDto
All Implemented Interfaces:
BaseDto, IndexableDto, ReferableDto, java.io.Serializable, java.lang.Cloneable, java.lang.Comparable, java.security.Principal
Direct Known Subclasses:
ReadOnlyUserDto

public class UserDto
extends NamedDto
implements ReferableDto, IndexableDto, java.security.Principal

Wraps a user account.

See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class com.intland.codebeamer.persistence.dto.base.NamedDto
NamedDto.NameComparator
 
Nested classes/interfaces inherited from class com.intland.codebeamer.persistence.dto.base.IdentifiableDto
IdentifiableDto.IdComparator
 
Nested classes/interfaces inherited from interface com.intland.codebeamer.persistence.dto.base.ReferableDto
ReferableDto.DescriptionComparator
 
Field Summary
static java.lang.String DEFAULT_DATE_FORMAT
           
static java.lang.String DEFAULT_DATE_TIME_FORMAT
           
static java.lang.String INACTIVATION
           
static java.lang.String INTERWIKI_LINK_TYPE
           
static java.lang.String MULTIPLE_EMAIL_DELIMITER
           
 
Fields inherited from interface com.intland.codebeamer.persistence.dto.base.ReferableDto
HEAD_VERSION, SECTION_DELIMITER, VERSION_DELIMITER
 
Constructor Summary
UserDto()
           
UserDto(java.lang.Integer userId)
           
UserDto(java.lang.Integer userId, java.lang.String name)
           
UserDto(NamedDto user)
           
UserDto(UserDto user)
          Create a copy of the specified user
 
Method Summary
 int compareTo(java.lang.Object obj)
          Caution: NamedDto compareTo violates the rule that a.equals(b) is equivalent to a.compareTo(b) == 0, because only the names are compared
 java.lang.String getAddress()
           
 java.lang.String getBrowser()
           
 java.lang.String getCity()
           
 java.lang.String getCompany()
           
 java.lang.String getCountry()
           
 java.lang.Number getCurrentWorkSpaceId()
           
 org.apache.commons.lang.time.FastDateFormat getDateFormat()
           
 java.lang.String getDateFormatPattern()
           
 java.lang.String getDatePattern()
           
 org.apache.commons.lang.time.FastDateFormat getDateTimeFormat()
           
 java.lang.String getDateTimeFormatPattern()
           
 java.lang.String getDateTimePattern()
           
 java.lang.String getDivisionSize()
           
 int getDownloadLimit()
           
 java.lang.String getEauthid()
           
 java.lang.String getEmail()
          The user's email addresses, can contain multiple email addresses separated with ";"-s
 java.lang.String getEmailClient()
           
 java.util.List<java.lang.String> getEmails()
           
 java.lang.String getFirstName()
           
 GeoLocationDto getGeoLocation()
           
 java.lang.String getHostName()
           
 java.lang.String getIconUrl()
          Returns the URL of the (small) icon image that represents this DTO type.
 java.lang.String getInterwikiLink()
          Returns the interwiki link that points to the web page where this DTO is managed.
 UserLicenseType getKind()
          Get the user/license type associated with this user, or null (default)
 java.util.Date getLastLogin()
           
 java.lang.String getLastName()
           
 javax.naming.Name getLdapName()
           
 java.lang.String getMapUrl()
           
 java.lang.String getMobile()
           
 java.lang.String getPassword()
           
 java.lang.String getPhone()
           
 java.lang.String getRealName()
           
 java.lang.String getReferrerUrl()
           
 java.util.Date getRegistryDate()
           
 java.lang.String getScc()
           
 java.lang.String getShortDescription()
          Returns the short description that represent this entity in the user interface.
 java.lang.String getSkills()
           
 java.lang.String getSourceOfInterest()
           
 java.lang.String getState()
           
 java.lang.String getStatus()
           
 java.lang.String getTeamSize()
           
 java.util.TimeZone getTimeZone()
           
 java.lang.String getTimeZonePattern()
           
 java.lang.String getTitle()
           
 java.lang.String getType()
          Get the product/license type associated with this user, or null (default)
 java.lang.String getUnused0()
           
 java.lang.String getUnused1()
           
 java.lang.String getUrlLink()
          Returns the local URL that points to the web page where this DTO is managed.
 java.lang.Integer getWikiHomepageId()
           
 java.lang.String getZip()
           
 int hashCode()
           
 boolean isActivated()
           
 boolean isAuthenticated()
           
 boolean isIndexed()
           
 boolean isLoggedIn()
           
 boolean kindOf(java.lang.Enum<?> check)
          Check if this user is kind of the specified UserType or LicenseKind
 boolean matches(java.lang.String flt)
           
 void setActivated(boolean act)
           
 void setAddress(java.lang.String address)
           
 void setAuthentication(boolean v)
           
 void setBrowser(java.lang.String browser)
           
 void setCity(java.lang.String city)
           
 void setCompany(java.lang.String company)
           
 void setCountry(java.lang.String country)
           
 void setCurrentWorkSpaceId(java.lang.Number id)
           
 void setDateFormatPattern(java.lang.String date_fmt)
           
 void setDateTimeFormatPattern(java.lang.String datetime_fmt)
           
 void setDivisionSize(java.lang.String divisionSize)
           
 void setDownloadLimit(int downloadLimit)
           
 void setEauthid(java.lang.String v)
           
 void setEmail(java.lang.String email)
           
 void setEmailClient(java.lang.String emailClient)
           
 void setFirstName(java.lang.String firstName)
           
 void setGeoLocation(GeoLocationDto geoLocation)
           
 void setHostName(java.lang.String hostName)
           
 void setIndexed(boolean indexed)
           
 void setKind(UserLicenseType kind)
          Set the user/license type to be associated with this user, or null (default)
 void setLastLogin(java.util.Date lastLogin)
           
 void setLastLoginTime(long dt)
           
 void setLastName(java.lang.String lastName)
           
 void setLdapName(javax.naming.Name ldapName)
           
 void setLoggedIn(boolean v)
           
 void setMobile(java.lang.String mobile)
           
 void setPassword(java.lang.String password)
           
 void setPhone(java.lang.String phone)
           
 void setReferrerUrl(java.lang.String referrerUrl)
           
 void setRegistryDate(java.util.Date registryDate)
           
 void setScc(java.lang.String scc)
           
 void setSkills(java.lang.String skills)
           
 void setSourceOfInterest(java.lang.String sourceOfInterest)
           
 void setState(java.lang.String state)
           
 void setStatus(java.lang.String status)
           
 void setTeamSize(java.lang.String teamSize)
           
 void setTimeZonePattern(java.lang.String tzp)
           
 void setTitle(java.lang.String title)
           
 void setType(java.lang.String type)
          Set the product/license type to associate with this user, or null (default)
 void setUnused0(java.lang.String unused0)
           
 void setUnused1(java.lang.String unused1)
           
 void setWikiHomepageId(java.lang.Integer wikiHomepageId)
           
 void setZip(java.lang.String zip)
           
static java.util.List<java.lang.String> splitEmails(java.lang.String multipleEmails)
          Split each eamils form a ";" separated email list.
 java.lang.String toString()
           
 
Methods inherited from class com.intland.codebeamer.persistence.dto.base.NamedDto
compareNames, compareString, compareStringIgnoreCase, createLookupMap, equals, getName, setName
 
Methods inherited from class com.intland.codebeamer.persistence.dto.base.IdentifiableDto
clone, compare, compareInteger, equals, getId, hashCode, setId
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface java.security.Principal
equals, getName
 

Field Detail

INTERWIKI_LINK_TYPE

public static final java.lang.String INTERWIKI_LINK_TYPE
See Also:
Constant Field Values

DEFAULT_DATE_TIME_FORMAT

public static final java.lang.String DEFAULT_DATE_TIME_FORMAT
See Also:
Constant Field Values

DEFAULT_DATE_FORMAT

public static final java.lang.String DEFAULT_DATE_FORMAT
See Also:
Constant Field Values

MULTIPLE_EMAIL_DELIMITER

public static final java.lang.String MULTIPLE_EMAIL_DELIMITER
See Also:
Constant Field Values

INACTIVATION

public static final java.lang.String INACTIVATION
See Also:
Constant Field Values
Constructor Detail

UserDto

public UserDto()

UserDto

public UserDto(java.lang.Integer userId)

UserDto

public UserDto(java.lang.Integer userId,
               java.lang.String name)

UserDto

public UserDto(NamedDto user)

UserDto

public UserDto(UserDto user)
Create a copy of the specified user

Method Detail

getRealName

public java.lang.String getRealName()

compareTo

public int compareTo(java.lang.Object obj)
Description copied from class: NamedDto
Caution: NamedDto compareTo violates the rule that a.equals(b) is equivalent to a.compareTo(b) == 0, because only the names are compared

Specified by:
compareTo in interface java.lang.Comparable
Overrides:
compareTo in class NamedDto

hashCode

public int hashCode()
Specified by:
hashCode in interface java.security.Principal
Overrides:
hashCode in class NamedDto

setEauthid

public void setEauthid(java.lang.String v)

getEauthid

public java.lang.String getEauthid()

setLastLoginTime

public void setLastLoginTime(long dt)

getCurrentWorkSpaceId

public java.lang.Number getCurrentWorkSpaceId()

setCurrentWorkSpaceId

public void setCurrentWorkSpaceId(java.lang.Number id)

getDateFormat

public org.apache.commons.lang.time.FastDateFormat getDateFormat()

getDatePattern

public java.lang.String getDatePattern()

getDateTimeFormat

public org.apache.commons.lang.time.FastDateFormat getDateTimeFormat()

getDateTimePattern

public java.lang.String getDateTimePattern()

isAuthenticated

public boolean isAuthenticated()

setAuthentication

public void setAuthentication(boolean v)

matches

public boolean matches(java.lang.String flt)

isLoggedIn

public boolean isLoggedIn()

setLoggedIn

public void setLoggedIn(boolean v)

getPassword

public java.lang.String getPassword()

setPassword

public void setPassword(java.lang.String password)

getStatus

public java.lang.String getStatus()

setStatus

public void setStatus(java.lang.String status)

setActivated

public void setActivated(boolean act)

isActivated

public boolean isActivated()

getType

public java.lang.String getType()
Get the product/license type associated with this user, or null (default)

Returns:
the product/license type associated with this user, or null

setType

public void setType(java.lang.String type)
Set the product/license type to associate with this user, or null (default)

Parameters:
type - is the product/license type to associate with this user, or null

getKind

public UserLicenseType getKind()
Get the user/license type associated with this user, or null (default)

Returns:
the user/license type associated with this user, or null (default)

setKind

public void setKind(UserLicenseType kind)
Set the user/license type to be associated with this user, or null (default)

Parameters:
kind - is the user/license type to be associated with this user, or null (default)

kindOf

public boolean kindOf(java.lang.Enum<?> check)
Check if this user is kind of the specified UserType or LicenseKind

Parameters:
check - is either a UserType or LicenseKind constant to check
Returns:
true is this user is a kind of the specified type, otherwise false

getHostName

public java.lang.String getHostName()

setHostName

public void setHostName(java.lang.String hostName)

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)

getTitle

public java.lang.String getTitle()

setTitle

public void setTitle(java.lang.String title)

getAddress

public java.lang.String getAddress()

setAddress

public void setAddress(java.lang.String address)

getZip

public java.lang.String getZip()

setZip

public void setZip(java.lang.String zip)

getCity

public java.lang.String getCity()

setCity

public void setCity(java.lang.String city)

getState

public java.lang.String getState()

setState

public void setState(java.lang.String state)

getSourceOfInterest

public java.lang.String getSourceOfInterest()

setSourceOfInterest

public void setSourceOfInterest(java.lang.String sourceOfInterest)

getScc

public java.lang.String getScc()

setScc

public void setScc(java.lang.String scc)

getTeamSize

public java.lang.String getTeamSize()

setTeamSize

public void setTeamSize(java.lang.String teamSize)

getDivisionSize

public java.lang.String getDivisionSize()

setDivisionSize

public void setDivisionSize(java.lang.String divisionSize)

getCompany

public java.lang.String getCompany()

setCompany

public void setCompany(java.lang.String company)

getCountry

public java.lang.String getCountry()

setCountry

public void setCountry(java.lang.String country)

getEmail

public java.lang.String getEmail()
The user's email addresses, can contain multiple email addresses separated with ";"-s

Returns:
The email

getEmails

public java.util.List<java.lang.String> getEmails()
Returns:
all emails for the user. This is same as getEmail(), but the email addresses are split by the ";"-s

setEmail

public void setEmail(java.lang.String email)

getEmailClient

public java.lang.String getEmailClient()

setEmailClient

public void setEmailClient(java.lang.String emailClient)

getPhone

public java.lang.String getPhone()

setPhone

public void setPhone(java.lang.String phone)

getMobile

public java.lang.String getMobile()

setMobile

public void setMobile(java.lang.String mobile)

getDateFormatPattern

public java.lang.String getDateFormatPattern()

setDateFormatPattern

public void setDateFormatPattern(java.lang.String date_fmt)

getDateTimeFormatPattern

public java.lang.String getDateTimeFormatPattern()

setDateTimeFormatPattern

public void setDateTimeFormatPattern(java.lang.String datetime_fmt)

getTimeZone

public java.util.TimeZone getTimeZone()

getTimeZonePattern

public java.lang.String getTimeZonePattern()

setTimeZonePattern

public void setTimeZonePattern(java.lang.String tzp)

getDownloadLimit

public int getDownloadLimit()

setDownloadLimit

public void setDownloadLimit(int downloadLimit)

getBrowser

public java.lang.String getBrowser()

setBrowser

public void setBrowser(java.lang.String browser)

getSkills

public java.lang.String getSkills()

setSkills

public void setSkills(java.lang.String skills)

getWikiHomepageId

public java.lang.Integer getWikiHomepageId()

setWikiHomepageId

public void setWikiHomepageId(java.lang.Integer wikiHomepageId)

getRegistryDate

public java.util.Date getRegistryDate()

setRegistryDate

public void setRegistryDate(java.util.Date registryDate)

getReferrerUrl

public java.lang.String getReferrerUrl()

setReferrerUrl

public void setReferrerUrl(java.lang.String referrerUrl)

getLastLogin

public java.util.Date getLastLogin()

setLastLogin

public void setLastLogin(java.util.Date lastLogin)

isIndexed

public boolean isIndexed()
Specified by:
isIndexed in interface IndexableDto

setIndexed

public void setIndexed(boolean indexed)
Specified by:
setIndexed in interface IndexableDto

getUnused0

public java.lang.String getUnused0()

setUnused0

public void setUnused0(java.lang.String unused0)

getUnused1

public java.lang.String getUnused1()

setUnused1

public void setUnused1(java.lang.String unused1)

getShortDescription

public java.lang.String getShortDescription()
Description copied from interface: ReferableDto
Returns the short description that represent this entity in the user interface. This normally delegates to another getter, like ProjectDto.getName() or TrackerItemDto.getSummary().

Specified by:
getShortDescription in interface ReferableDto

getUrlLink

public java.lang.String getUrlLink()
Description copied from interface: ReferableDto
Returns the local URL that points to the web page where this DTO is managed.

Specified by:
getUrlLink in interface ReferableDto

getInterwikiLink

public java.lang.String getInterwikiLink()
Description copied from interface: ReferableDto
Returns the interwiki link that points to the web page where this DTO is managed.

Specified by:
getInterwikiLink in interface ReferableDto

getIconUrl

public java.lang.String getIconUrl()
Description copied from interface: ReferableDto
Returns the URL of the (small) icon image that represents this DTO type.

Specified by:
getIconUrl in interface ReferableDto

getMapUrl

public java.lang.String getMapUrl()

getGeoLocation

public GeoLocationDto getGeoLocation()

setGeoLocation

public void setGeoLocation(GeoLocationDto geoLocation)

toString

public java.lang.String toString()
Specified by:
toString in interface java.security.Principal
Overrides:
toString in class NamedDto

splitEmails

public static java.util.List<java.lang.String> splitEmails(java.lang.String multipleEmails)
Split each eamils form a ";" separated email list.

Parameters:
multipleEmails -
Returns:
The split emails.

getLdapName

public javax.naming.Name getLdapName()

setLdapName

public void setLdapName(javax.naming.Name ldapName)

CodeBeamer 5.4.0.1-RC API

Copyright © 2006-2009 Intland Software. All rights reserved.