|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.buildforge.services.common.dbo.DBObject
com.buildforge.services.common.dbo.StepDBO
public class StepDBO
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 |
---|
public static final java.lang.String TYPE_KEY
public static final char FLAG_DEACTIVATE
Constructor Detail |
---|
public StepDBO()
Method Detail |
---|
public java.lang.String getTypeKey()
DBObject
getTypeKey
in class DBObject
public boolean isLive()
DBObject
isLive
in class DBObject
public boolean getAbsolute()
public boolean getActive()
public boolean getBroadcast()
public java.lang.String getCommandKey()
public java.lang.String getCommandText()
public java.lang.String getDescription()
public java.lang.String getDirectory()
public int getEnvironmentId()
public int getFailChainId()
public java.lang.String getFailNotify()
public boolean getFailWait()
public int getFilterSetId()
public int getInlineChainId()
public int getLevel()
public StepDBO.OnFail getOnFail()
public int getPassChainId()
public java.lang.String getPassNotify()
public boolean getPassWait()
public int getProjectId()
public java.lang.String getResource()
public int getStepOrdinal()
public StepDBO.Threaded getThreaded()
public int getTimeout()
public java.lang.String getUid()
public void setAbsolute(boolean absolute)
public void setActive(boolean active)
public void setBroadcast(boolean broadcast)
public void setCommandKey(java.lang.String commandKey)
public void setCommandText(java.lang.String commandText)
public void setDescription(java.lang.String description)
public void setDirectory(java.lang.String directory)
public void setEnvironmentId(int environmentId)
public void setFailChainId(int failChainId)
public void setFailNotify(java.lang.String failNotify)
public void setFailWait(boolean failWait)
public void setFilterSetId(int filterSetId)
public void setInlineChainId(int inlineChainId)
public void setLevel(int level)
public void setOnFail(StepDBO.OnFail onFail)
public void setPassChainId(int passChainId)
public void setPassNotify(java.lang.String passNotify)
public void setPassWait(boolean passWait)
public void setProjectId(int projectId)
public void setResource(java.lang.String resource)
public void setStepOrdinal(int stepOrdinal)
public void setThreaded(StepDBO.Threaded threaded)
public void setTimeout(int timeout)
public void setUid(java.lang.String uid)
public static void sanityCheck(StepDBO step) throws APIException
APIException
public boolean equals(java.lang.Object o)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public java.lang.String toString()
toString
in class java.lang.Object
public StepDBO fromArray(java.lang.Object[] data) throws APIException
DBObject
DBObject.toArray()
.
fromArray
in class DBObject
data
- the object list that renders this object
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.public java.lang.Object[] toArray()
DBObject
Protocol
, all supported
protocols transfer database objects in this form.
toArray
in class DBObject
public StepDBO clone()
clone
in class java.lang.Object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |