com.buildforge.services.common.dbo
Class EngineDBO

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

public class EngineDBO
extends DBObject

Database information representing Build Forge engines. Each engine gets its own EngineDBO for storing its licensing and status. This information is not intended for direct manipulation by an end user.


Field Summary
static char FLAG_RESUME
           
static java.lang.String TYPE_KEY
           
 
Constructor Summary
EngineDBO()
           
 
Method Summary
 EngineDBO fromArray(java.lang.Object[] data)
          Deserialize the database object's settings from a request array.
 char getAlive()
           
 java.lang.String getBias()
           
 java.lang.String getEngineId()
           
 char getLicense()
           
 char getMaster()
           
 int getMResponse()
           
 java.lang.String getPing()
           
 int getPopulation()
           
 char getReqMaster()
           
 int getSResponse()
           
 int getTick()
           
 java.lang.String getTypeKey()
          Retrieve the key that should be used to look up the display name for a data type.
 int getUptime()
           
 java.lang.String getVersion()
           
 java.lang.String getZone()
           
 boolean isLive()
          Checks whether or not the object is live.
static void sanityCheck(java.lang.String engineId)
           
 void setAlive(char alive)
           
 void setBias(java.lang.String bias)
           
 void setEngineId(java.lang.String engineId)
           
 void setLicense(char license)
           
 void setMaster(char master)
           
 void setMResponse(int response)
           
 void setPing(java.lang.String ping)
           
 void setPopulation(int population)
           
 void setReqMaster(char reqMaster)
           
 void setSResponse(int response)
           
 void setTick(int tick)
           
 void setUptime(int uptime)
           
 void setVersion(java.lang.String version)
           
 void setZone(java.lang.String zone)
           
 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

FLAG_RESUME

public static final char FLAG_RESUME
See Also:
Constant Field Values
Constructor Detail

EngineDBO

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

getAlive

public char getAlive()

getBias

public java.lang.String getBias()

getEngineId

public java.lang.String getEngineId()

getLicense

public char getLicense()

getMaster

public char getMaster()

getMResponse

public int getMResponse()

getPing

public java.lang.String getPing()

getPopulation

public int getPopulation()

getReqMaster

public char getReqMaster()

getSResponse

public int getSResponse()

getTick

public int getTick()

getUptime

public int getUptime()

getVersion

public java.lang.String getVersion()

getZone

public java.lang.String getZone()

setAlive

public void setAlive(char alive)

setBias

public void setBias(java.lang.String bias)

setEngineId

public void setEngineId(java.lang.String engineId)

setLicense

public void setLicense(char license)

setMaster

public void setMaster(char master)

setMResponse

public void setMResponse(int response)

setPing

public void setPing(java.lang.String ping)

setPopulation

public void setPopulation(int population)

setReqMaster

public void setReqMaster(char reqMaster)

setSResponse

public void setSResponse(int response)

setTick

public void setTick(int tick)

setUptime

public void setUptime(int uptime)

setVersion

public void setVersion(java.lang.String version)

setZone

public void setZone(java.lang.String zone)

sanityCheck

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

toString

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

fromArray

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