com.buildforge.services.common.dbo
Class BOMDBO

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

public class BOMDBO
extends DBObject

The database information representing the user-provided Bill of Materials (BOM) data. This class is not yet fully implemented.


Nested Class Summary
static class BOMDBO.Type
          Identifies the type of entry from a .scan.
 
Field Summary
static java.lang.String TYPE_KEY
           
 
Constructor Summary
BOMDBO()
           
 
Method Summary
 BOMDBO fromArray(java.lang.Object[] data)
          Deserialize the database object's settings from a request array.
 int getBuildId()
           
 java.lang.String getData()
           
 java.lang.String getName()
           
 java.lang.String getPath()
           
 java.lang.String getStepResultId()
           
 BOMDBO.Type getType()
           
 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 buildId)
           
 void setData(java.lang.String data)
           
 void setName(java.lang.String name)
           
 void setPath(java.lang.String path)
           
 void setStepResultId(java.lang.String id)
           
 void setType(BOMDBO.Type type)
           
 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

BOMDBO

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

getData

public java.lang.String getData()

getName

public java.lang.String getName()

getPath

public java.lang.String getPath()

getStepResultId

public java.lang.String getStepResultId()

getType

public BOMDBO.Type getType()

setBuildId

public void setBuildId(int buildId)

setData

public void setData(java.lang.String data)

setName

public void setName(java.lang.String name)

setPath

public void setPath(java.lang.String path)

setStepResultId

public void setStepResultId(java.lang.String id)

setType

public void setType(BOMDBO.Type type)

toString

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

fromArray

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