com.buildforge.services.common.dbo
Class NoteDBO

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

public class NoteDBO
extends DBObject

Database information represents a note that is attached to some other object within the Build Forge system. Currently, only notes that are attached to steps are supported, but the plan is to eventually support notes for nearly every kind of object in the Build Forge system.


Field Summary
static java.lang.String TYPE_KEY
           
 
Constructor Summary
NoteDBO()
           
 
Method Summary
 NoteDBO fromArray(java.lang.Object[] data)
          Deserialize the database object's settings from a request array.
 int getCreatedTimestamp()
           
 java.lang.String getDataKey()
           
 java.lang.String getDataText()
           
 int getProjectId()
           
 java.lang.String getTargetId()
           
 java.lang.String getType()
           
 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 sanityCheckProject(int projectId)
           
static void sanityCheckTarget(java.lang.String targetId)
           
 void setCreatedTimestamp(int createdTimestamp)
           
 void setDataKey(java.lang.String dataKey)
           
 void setDataText(java.lang.String dataText)
           
 void setProjectId(int projectId)
           
 void setTargetId(java.lang.String targetId)
           
 void setType(java.lang.String type)
           
 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

NoteDBO

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

getCreatedTimestamp

public int getCreatedTimestamp()

getDataKey

public java.lang.String getDataKey()

getDataText

public java.lang.String getDataText()

getProjectId

public int getProjectId()

getTargetId

public java.lang.String getTargetId()

getType

public java.lang.String getType()

getUserId

public int getUserId()

setCreatedTimestamp

public void setCreatedTimestamp(int createdTimestamp)

setDataKey

public void setDataKey(java.lang.String dataKey)

setDataText

public void setDataText(java.lang.String dataText)

setProjectId

public void setProjectId(int projectId)

setTargetId

public void setTargetId(java.lang.String targetId)

setType

public void setType(java.lang.String type)

setUserId

public void setUserId(int userId)

sanityCheckTarget

public static void sanityCheckTarget(java.lang.String targetId)
                              throws APIException
Throws:
APIException

sanityCheckProject

public static void sanityCheckProject(int projectId)
                               throws APIException
Throws:
APIException

toString

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

fromArray

public NoteDBO 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