com.buildforge.services.common.dbo
Class ResultDBO

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

public class ResultDBO
extends DBObject

Database information representing the results of an individual step within a build.


Nested Class Summary
static class ResultDBO.Floating
          Floating state is related to the implementation of the project sticky flag.
static class ResultDBO.StepFlag
          Identifies the current step flag, which controls special behaviors like cancelling or skipping a step.
static class ResultDBO.StepResult
          Identifies the current state of the step.
 
Field Summary
static java.lang.Class<ResultDBO> CLASS
           
static char FLAG_GET_COMMAND
           
static char FLAG_GET_ENV
           
static java.lang.String TYPE_KEY
           
 
Constructor Summary
ResultDBO()
           
 
Method Summary
 ResultDBO fromArray(java.lang.Object[] data)
          Deserialize the database object's settings from a request array.
 boolean getAbsolute()
           
 boolean getBroadcast()
           
 int getBuildId()
           
 int getCaller()
           
 int getChainedBuildId()
           
 int getChainId()
           
 java.lang.String getCommandKey()
           
 java.lang.String getCommandText()
           
 java.lang.String getDescription()
           
 java.lang.String getDirectory()
           
 int getDuration()
           
 int getEnvironmentGroupId()
           
 java.lang.String getEnvironmentKey()
           
 java.lang.String getEnvironmentText()
           
 int getFailChainId()
           
 java.lang.String getFailNotify()
           
 boolean getFailWait()
           
 int getFilterSetId()
           
 int getFinish()
           
 ResultDBO.StepFlag getFlag()
           
 ResultDBO.Floating getFloating()
           
 int getLevel()
           
 java.lang.String getLogId()
           
 StepDBO.OnFail getOnFail()
           
 int getOriginalStepId()
           
 int getOwner()
           
 int getPassChainId()
           
 java.lang.String getPassNotify()
           
 boolean getPassWait()
           
 int getProjectId()
           
 java.lang.String getResource()
           
 ResultDBO.StepResult getResult()
           
 int getResultStepId()
           
 java.lang.String getServer()
           
 int getStartTimestamp()
           
 StepDBO.Threaded getThreaded()
           
 int getTimeout()
           
 java.lang.String getTypeKey()
          Retrieve the key that should be used to look up the display name for a data type.
 java.lang.String getUid()
           
 boolean isLive()
          Checks whether or not the object is live.
 void setAbsolute(boolean absolute)
           
 void setBroadcast(boolean broadcast)
           
 void setBuildId(int buildId)
           
 void setCaller(int caller)
           
 void setChainedBuildId(int chainedBuildId)
           
 void setChainId(int chainId)
           
 void setCommandKey(java.lang.String commandKey)
           
 void setCommandText(java.lang.String commandText)
           
 void setDescription(java.lang.String description)
           
 void setDirectory(java.lang.String directory)
           
 void setDuration(int duration)
           
 void setEnvironmentGroupId(int environmentGroupId)
           
 void setEnvironmentKey(java.lang.String environmentKey)
           
 void setEnvironmentText(java.lang.String environmentText)
           
 void setFailChainId(int failChainId)
           
 void setFailNotify(java.lang.String failNotify)
           
 void setFailWait(boolean failWait)
           
 void setFilterSetId(int filterSetId)
           
 void setFinish(int finish)
           
 void setFlag(ResultDBO.StepFlag flag)
           
 void setFloating(ResultDBO.Floating floating)
           
 void setLevel(int level)
           
 void setLogId(java.lang.String logId)
           
 void setOnFail(StepDBO.OnFail onFail)
           
 void setOriginalStepId(int originalStepId)
           
 void setOwner(int owner)
           
 void setPassChainId(int passChainId)
           
 void setPassNotify(java.lang.String passNotify)
           
 void setPassWait(boolean passWait)
           
 void setProjectId(int projectId)
           
 void setResource(java.lang.String resource)
           
 void setResult(ResultDBO.StepResult result)
           
 void setResultStepId(int resultStepId)
           
 void setServer(java.lang.String server)
           
 void setStartTimestamp(int startTimestamp)
           
 void setThreaded(StepDBO.Threaded threaded)
           
 void setTimeout(int timeout)
           
 void setUid(java.lang.String id)
           
 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

CLASS

public static final java.lang.Class<ResultDBO> CLASS

FLAG_GET_COMMAND

public static final char FLAG_GET_COMMAND
See Also:
Constant Field Values

FLAG_GET_ENV

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

ResultDBO

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

getAbsolute

public boolean getAbsolute()

getBroadcast

public boolean getBroadcast()

getBuildId

public int getBuildId()

getCaller

public int getCaller()

getChainedBuildId

public int getChainedBuildId()

getChainId

public int getChainId()

getCommandKey

public java.lang.String getCommandKey()

getCommandText

public java.lang.String getCommandText()

getDescription

public java.lang.String getDescription()

getDirectory

public java.lang.String getDirectory()

getDuration

public int getDuration()

getEnvironmentGroupId

public int getEnvironmentGroupId()

getEnvironmentKey

public java.lang.String getEnvironmentKey()

getEnvironmentText

public java.lang.String getEnvironmentText()

getFailChainId

public int getFailChainId()

getFailNotify

public java.lang.String getFailNotify()

getFailWait

public boolean getFailWait()

getFilterSetId

public int getFilterSetId()

getFinish

public int getFinish()

getFlag

public ResultDBO.StepFlag getFlag()

getFloating

public ResultDBO.Floating getFloating()

getLevel

public int getLevel()

getLogId

public java.lang.String getLogId()

getOnFail

public StepDBO.OnFail getOnFail()

getOriginalStepId

public int getOriginalStepId()

getOwner

public int getOwner()

getPassChainId

public int getPassChainId()

getPassNotify

public java.lang.String getPassNotify()

getPassWait

public boolean getPassWait()

getProjectId

public int getProjectId()

getResource

public java.lang.String getResource()

getResult

public ResultDBO.StepResult getResult()

getResultStepId

public int getResultStepId()

getServer

public java.lang.String getServer()

getStartTimestamp

public int getStartTimestamp()

getThreaded

public StepDBO.Threaded getThreaded()

getTimeout

public int getTimeout()

getUid

public java.lang.String getUid()

setAbsolute

public void setAbsolute(boolean absolute)

setBroadcast

public void setBroadcast(boolean broadcast)

setBuildId

public void setBuildId(int buildId)

setCaller

public void setCaller(int caller)

setChainedBuildId

public void setChainedBuildId(int chainedBuildId)

setChainId

public void setChainId(int chainId)

setCommandKey

public void setCommandKey(java.lang.String commandKey)

setCommandText

public void setCommandText(java.lang.String commandText)

setDescription

public void setDescription(java.lang.String description)

setDirectory

public void setDirectory(java.lang.String directory)

setDuration

public void setDuration(int duration)

setEnvironmentGroupId

public void setEnvironmentGroupId(int environmentGroupId)

setEnvironmentKey

public void setEnvironmentKey(java.lang.String environmentKey)

setEnvironmentText

public void setEnvironmentText(java.lang.String environmentText)

setFailChainId

public void setFailChainId(int failChainId)

setFailNotify

public void setFailNotify(java.lang.String failNotify)

setFailWait

public void setFailWait(boolean failWait)

setFilterSetId

public void setFilterSetId(int filterSetId)

setFinish

public void setFinish(int finish)

setFlag

public void setFlag(ResultDBO.StepFlag flag)

setFloating

public void setFloating(ResultDBO.Floating floating)

setLevel

public void setLevel(int level)

setLogId

public void setLogId(java.lang.String logId)

setOnFail

public void setOnFail(StepDBO.OnFail onFail)

setOriginalStepId

public void setOriginalStepId(int originalStepId)

setOwner

public void setOwner(int owner)

setPassChainId

public void setPassChainId(int passChainId)

setPassNotify

public void setPassNotify(java.lang.String passNotify)

setPassWait

public void setPassWait(boolean passWait)

setProjectId

public void setProjectId(int projectId)

setResource

public void setResource(java.lang.String resource)

setResult

public void setResult(ResultDBO.StepResult result)

setResultStepId

public void setResultStepId(int resultStepId)

setServer

public void setServer(java.lang.String server)

setStartTimestamp

public void setStartTimestamp(int startTimestamp)

setThreaded

public void setThreaded(StepDBO.Threaded threaded)

setTimeout

public void setTimeout(int timeout)

setUid

public void setUid(java.lang.String id)

toString

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

fromArray

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