com.buildforge.services.common.dbo
Class DataDBO

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

public class DataDBO
extends DBObject

Database information presenting register data. Register data can belong either to a project or to a specific build. These cases are distinguished in the descriptions below.


Field Summary
static java.lang.String TYPE_KEY
           
 
Constructor Summary
DataDBO()
           
 
Method Summary
 DataDBO fromArray(java.lang.Object[] data)
          Deserialize the database object's settings from a request array.
 int getBuildId()
           
 java.lang.String getDataKey()
           
 java.lang.String getDataText()
           
 int getLiveBuildId()
           
 int getLiveProjectId()
           
 java.lang.String getLiveRegister()
           
 int getProjectId()
           
 java.lang.String getRegister()
           
 int getStamp()
           
 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.
static void sanityCheck(java.lang.String registerName)
           
 void setBuildId(int buildId)
           
 void setDataKey(java.lang.String newDataKey)
           
 void setDataText(java.lang.String newText)
           
 void setLiveBuildId(int liveBuildId)
           
 void setLiveProjectId(int liveProjectId)
           
 void setLiveRegister(java.lang.String liveRegister)
           
 void setProjectId(int projectId)
           
 void setRegister(java.lang.String register)
           
 void setStamp(int stamp)
           
 void setUserId(int userId)
           
 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
Constructor Detail

DataDBO

public DataDBO()
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.

getBuildId

public int getBuildId()

getDataKey

public java.lang.String getDataKey()

getDataText

public java.lang.String getDataText()

getProjectId

public int getProjectId()

getRegister

public java.lang.String getRegister()

getStamp

public int getStamp()

getUserId

public int getUserId()

getLiveBuildId

public int getLiveBuildId()

getLiveProjectId

public int getLiveProjectId()

getLiveRegister

public java.lang.String getLiveRegister()

setBuildId

public void setBuildId(int buildId)

setDataKey

public void setDataKey(java.lang.String newDataKey)

setDataText

public void setDataText(java.lang.String newText)

setProjectId

public void setProjectId(int projectId)

setRegister

public void setRegister(java.lang.String register)

setStamp

public void setStamp(int stamp)

setUserId

public void setUserId(int userId)

setLiveBuildId

public void setLiveBuildId(int liveBuildId)

setLiveProjectId

public void setLiveProjectId(int liveProjectId)

setLiveRegister

public void setLiveRegister(java.lang.String liveRegister)

sanityCheck

public static void sanityCheck(java.lang.String registerName)
                        throws APIException
Throws:
APIException

toString

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

fromArray

public DataDBO 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.

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