com.buildforge.services.common.dbo
Class BOMManifestDBO

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

public class BOMManifestDBO
extends DBObject

Database information representing the server manifest snapshots taken during the running of a build. This information is later made available as part of the Bill of Materials (BOM). This class is not yet fully implemented.


Field Summary
static java.lang.String TYPE_KEY
           
 
Constructor Summary
BOMManifestDBO()
           
 
Method Summary
 BOMManifestDBO fromArray(java.lang.Object[] data)
          Deserialize the database object's settings from a request array.
 int getBuildId()
           
 java.lang.String getLinkId()
           
 java.lang.String getName()
           
 java.lang.String getPropertyName()
           
 java.lang.String getPropertyValue()
           
 java.lang.String getTypeKey()
          Retrieve the key that should be used to look up the display name for a data type.
 boolean isLive()
          Checks whether or not the object is live.
 void setBuildId(int bomId)
           
 void setLinkId(java.lang.String newLinkId)
           
 void setName(java.lang.String name)
           
 void setPropertyName(java.lang.String data)
           
 void setPropertyValue(java.lang.String newValue)
           
 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

BOMManifestDBO

public BOMManifestDBO()
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()

getPropertyName

public java.lang.String getPropertyName()

getName

public java.lang.String getName()

getPropertyValue

public java.lang.String getPropertyValue()

getLinkId

public java.lang.String getLinkId()

setBuildId

public void setBuildId(int bomId)

setPropertyName

public void setPropertyName(java.lang.String data)

setName

public void setName(java.lang.String name)

setPropertyValue

public void setPropertyValue(java.lang.String newValue)

setLinkId

public void setLinkId(java.lang.String newLinkId)

toString

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

fromArray

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