com.buildforge.services.common.dbo
Class UserDBO

java.lang.Object
  extended by com.buildforge.services.common.dbo.DBObject
      extended by com.buildforge.services.common.dbo.UserDBO

public class UserDBO
extends DBObject

Database information representing a Build Forge user. The user record contains basic information about the user, such as the user's password and E-mail address, but it also contains some user preferences settings, such as the user's preferred time zone.


Field Summary
static java.lang.Class<UserDBO> CLASS
           
static java.lang.String NO
           
static java.lang.String TYPE_KEY
           
static java.lang.String YES
           
 
Constructor Summary
UserDBO()
           
 
Method Summary
 UserDBO fromArray(java.lang.Object[] data)
          Deserialize the database object's settings from a request array.
 java.lang.String getData()
           
 java.lang.String getDataKey()
           
 java.lang.String getDateFormat()
           
 java.lang.String getEmail()
           
 boolean getLdap()
           
 int getLevelHint()
           
 java.lang.String getLocale()
           
 java.lang.String getLogin()
           
 int getMaxBuilds()
           
 java.lang.String getName()
           
 java.lang.String getPassword()
           
 boolean getPasswordExpired()
           
 boolean getPasswordExpires()
           
 int getPasswordUpdated()
           
 boolean getPriority()
           
 java.lang.String getTimeZone()
           
 java.lang.String getTypeKey()
          Retrieve the key that should be used to look up the display name for a data type.
 int getUserId()
           
 boolean isLive()
          Checks whether or not the object is live.
 void setData(java.lang.String dataText)
           
 void setDataKey(java.lang.String dataKey)
           
 void setDateFormat(java.lang.String datefmt)
           
 void setEmail(java.lang.String email)
           
 void setLdap(boolean ldap)
           
 void setLevelHint(int levelHint)
           
 void setLocale(java.lang.String locale)
           
 void setLogin(java.lang.String login)
           
 void setMaxBuilds(int maxbuilds)
           
 void setName(java.lang.String name)
           
 void setPassword(java.lang.String password)
           
 void setPasswordExpired(boolean pwexpired)
           
 void setPasswordExpires(boolean pexpire)
           
 void setPasswordUpdated(int pupdate)
           
 void setPriority(boolean priority)
           
 void setTimeZone(java.lang.String tzone)
           
 void setUserId(int newId)
           
 java.lang.Object[] toArray()
          Serializes this database object as an array of objects.
 java.lang.String toString()
           
 
Methods inherited from class com.buildforge.services.common.dbo.DBObject
badId, badName, checkDead, checkLive, collision, collision
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

TYPE_KEY

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

CLASS

public static final java.lang.Class<UserDBO> CLASS

YES

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

NO

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

UserDBO

public UserDBO()
Method Detail

getTypeKey

public java.lang.String getTypeKey()
Description copied from class: DBObject
Retrieve the key that should be used to look up the display name for a data type.

Specified by:
getTypeKey in class DBObject
Returns:
the type key for this object's class

isLive

public boolean isLive()
Description copied from class: DBObject
Checks whether or not the object is live. Note that this is not valid for object types that do not have a unique identifier. Those for which no reasonable implementation exists should always return false.

Specified by:
isLive in class DBObject
Returns:
true iff liveness is a valid concept for this object, and the object is live; otherwise, false is returned.

getUserId

public int getUserId()

getLevelHint

public int getLevelHint()

getName

public java.lang.String getName()

getEmail

public java.lang.String getEmail()

getLogin

public java.lang.String getLogin()

getPassword

public java.lang.String getPassword()

getMaxBuilds

public int getMaxBuilds()

getPasswordUpdated

public int getPasswordUpdated()

getPasswordExpires

public boolean getPasswordExpires()

getPasswordExpired

public boolean getPasswordExpired()

getTimeZone

public java.lang.String getTimeZone()

getDateFormat

public java.lang.String getDateFormat()

getPriority

public boolean getPriority()

getLocale

public java.lang.String getLocale()

getDataKey

public java.lang.String getDataKey()

getData

public java.lang.String getData()

getLdap

public boolean getLdap()

setUserId

public void setUserId(int newId)

setLevelHint

public void setLevelHint(int levelHint)

setName

public void setName(java.lang.String name)

setEmail

public void setEmail(java.lang.String email)

setLogin

public void setLogin(java.lang.String login)

setPassword

public void setPassword(java.lang.String password)

setMaxBuilds

public void setMaxBuilds(int maxbuilds)

setPasswordUpdated

public void setPasswordUpdated(int pupdate)

setPasswordExpires

public void setPasswordExpires(boolean pexpire)

setPasswordExpired

public void setPasswordExpired(boolean pwexpired)

setTimeZone

public void setTimeZone(java.lang.String tzone)

setDateFormat

public void setDateFormat(java.lang.String datefmt)

setPriority

public void setPriority(boolean priority)

setLocale

public void setLocale(java.lang.String locale)

setDataKey

public void setDataKey(java.lang.String dataKey)

setData

public void setData(java.lang.String dataText)

setLdap

public void setLdap(boolean ldap)

toArray

public java.lang.Object[] toArray()
Description copied from class: DBObject
Serializes this database object as an array of objects. As specified in the description for Protocol, all supported protocols transfer database objects in this form.

Specified by:
toArray in class DBObject

fromArray

public UserDBO fromArray(java.lang.Object[] data)
                  throws APIException
Description copied from class: DBObject
Deserialize the database object's settings from a request array. This method is used to reconstruct a database object from the array that was created by DBObject.toArray().

Specified by:
fromArray in class DBObject
Parameters:
data - the object list that renders this object
Returns:
this object, for convenience
Throws:
APIException - if there is something wrong with the serialized data that interferes with the reconstruction of the object. The most obvious reason for this would be if the serialized array contains the wrong number of fields or otherwise does not match the serialized form for this type of database object.

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object