com.buildforge.services.common.dbo
Class StepDBO

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

public class StepDBO
extends DBObject

Database information representing the definition of a step within a project.


Nested Class Summary
static class StepDBO.OnFail
          Indicates the action that the Build Forge engine should take if this step fails.
static class StepDBO.Threaded
          Indicates whether this step is threaded, not threaded, or threaded but joined only to the preceding thread block.
 
Field Summary
static char FLAG_DEACTIVATE
           
static java.lang.String TYPE_KEY
           
 
Constructor Summary
StepDBO()
           
 
Method Summary
 StepDBO clone()
           
 boolean equals(java.lang.Object o)
           
 StepDBO fromArray(java.lang.Object[] data)
          Deserialize the database object's settings from a request array.
 boolean getAbsolute()
           
 boolean getActive()
           
 boolean getBroadcast()
           
 java.lang.String getCommandKey()
           
 java.lang.String getCommandText()
           
 java.lang.String getDescription()
           
 java.lang.String getDirectory()
           
 int getEnvironmentId()
           
 int getFailChainId()
           
 java.lang.String getFailNotify()
           
 boolean getFailWait()
           
 int getFilterSetId()
           
 int getInlineChainId()
           
 int getLevel()
           
 StepDBO.OnFail getOnFail()
           
 int getPassChainId()
           
 java.lang.String getPassNotify()
           
 boolean getPassWait()
           
 int getProjectId()
           
 java.lang.String getResource()
           
 int getStepOrdinal()
           
 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()
           
 int hashCode()
           
 boolean isLive()
          Checks whether or not the object is live.
static void sanityCheck(StepDBO step)
           
 void setAbsolute(boolean absolute)
           
 void setActive(boolean active)
           
 void setBroadcast(boolean broadcast)
           
 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 setEnvironmentId(int environmentId)
           
 void setFailChainId(int failChainId)
           
 void setFailNotify(java.lang.String failNotify)
           
 void setFailWait(boolean failWait)
           
 void setFilterSetId(int filterSetId)
           
 void setInlineChainId(int inlineChainId)
           
 void setLevel(int level)
           
 void setOnFail(StepDBO.OnFail onFail)
           
 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 setStepOrdinal(int stepOrdinal)
           
 void setThreaded(StepDBO.Threaded threaded)
           
 void setTimeout(int timeout)
           
 void setUid(java.lang.String uid)
           
 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
getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

TYPE_KEY

public static final java.lang.String TYPE_KEY
See Also:
Constant Field Values

FLAG_DEACTIVATE

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

StepDBO

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

getActive

public boolean getActive()

getBroadcast

public boolean getBroadcast()

getCommandKey

public java.lang.String getCommandKey()

getCommandText

public java.lang.String getCommandText()

getDescription

public java.lang.String getDescription()

getDirectory

public java.lang.String getDirectory()

getEnvironmentId

public int getEnvironmentId()

getFailChainId

public int getFailChainId()

getFailNotify

public java.lang.String getFailNotify()

getFailWait

public boolean getFailWait()

getFilterSetId

public int getFilterSetId()

getInlineChainId

public int getInlineChainId()

getLevel

public int getLevel()

getOnFail

public StepDBO.OnFail getOnFail()

getPassChainId

public int getPassChainId()

getPassNotify

public java.lang.String getPassNotify()

getPassWait

public boolean getPassWait()

getProjectId

public int getProjectId()

getResource

public java.lang.String getResource()

getStepOrdinal

public int getStepOrdinal()

getThreaded

public StepDBO.Threaded getThreaded()

getTimeout

public int getTimeout()

getUid

public java.lang.String getUid()

setAbsolute

public void setAbsolute(boolean absolute)

setActive

public void setActive(boolean active)

setBroadcast

public void setBroadcast(boolean broadcast)

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)

setEnvironmentId

public void setEnvironmentId(int environmentId)

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)

setInlineChainId

public void setInlineChainId(int inlineChainId)

setLevel

public void setLevel(int level)

setOnFail

public void setOnFail(StepDBO.OnFail onFail)

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)

setStepOrdinal

public void setStepOrdinal(int stepOrdinal)

setThreaded

public void setThreaded(StepDBO.Threaded threaded)

setTimeout

public void setTimeout(int timeout)

setUid

public void setUid(java.lang.String uid)

sanityCheck

public static void sanityCheck(StepDBO step)
                        throws APIException
Throws:
APIException

equals

public boolean equals(java.lang.Object o)
Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object

toString

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

fromArray

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

clone

public StepDBO clone()
Overrides:
clone in class java.lang.Object