|
|||||||||
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.GeoAwareDBObject
com.buildforge.services.common.dbo.ProjectDBO
public class ProjectDBO
Database information representing a project definition.
Nested Class Summary | |
---|---|
static class |
ProjectDBO.InUse
How this project is currently being used. |
Field Summary | |
---|---|
static char |
ACTIVE_NO
|
static char |
ACTIVE_YES
|
static java.lang.Class<ProjectDBO> |
CLASS
|
static char |
STICKY_NO
|
static char |
STICKY_YES
|
static java.lang.String |
TYPE_KEY
|
Constructor Summary | |
---|---|
ProjectDBO()
|
Method Summary | |
---|---|
void |
addStep(StepDBO newStep)
Adds a child Step object to this project at the end of the current list of steps |
void |
addStep(StepDBO newStep,
int index)
Adds a child Step object to this project at the specified, 0-based index in the list of steps. |
ProjectDBO |
clone()
|
void |
copyStep(int fromIndex,
int toIndex,
java.lang.String newStepUid)
Copies the specified step to another location in the step list and assigns a new unique ID to the copy. |
void |
copyStep(int fromIndex,
java.lang.String newStepUid)
Copies the specified step to the end of the step list and assigns a new unique ID to the copy. |
ProjectDBO |
fromArray(java.lang.Object[] data)
Deserialize the database object's settings from a request array. |
boolean |
getActive()
|
java.lang.String |
getBuildClass()
|
int |
getEnvironmentId()
|
int |
getFailChainId()
|
int |
getFailNotify()
|
int |
getLevel()
|
int |
getMaxThread()
|
java.lang.String |
getName()
|
int |
getPassChainId()
|
int |
getPassNotify()
|
int |
getProjectId()
|
int |
getRunLimit()
|
java.lang.String |
getSelectorId()
|
int |
getStartNotify()
|
StepDBO |
getStep(int index)
Retrieves a step from this project using its index within the step list. |
StepDBO |
getStep(java.lang.String uid)
Retrieves a step by its unique ID. |
java.util.List<StepDBO> |
getSteps()
|
boolean |
getSticky()
|
java.lang.String |
getTag()
|
int |
getTagSync()
|
java.lang.String |
getTypeKey()
Retrieve the key that should be used to look up the display name for a data type. |
int |
hashCode()
|
boolean |
isLive()
Checks whether or not the object is live. |
void |
moveStep(int fromIndex,
int toIndex)
Moves the specified step to another location in the step list. |
StepDBO |
removeStep(int index)
Removes the specified child step from this project. |
StepDBO |
removeStep(java.lang.String stepUid)
Removes a child step from this project using its unique identifier. |
void |
setActive(boolean active)
|
void |
setBuildClass(java.lang.String buildClass)
|
void |
setEnvironmentId(int environmentId)
|
void |
setFailChainId(int newChain)
|
void |
setFailNotify(int notify)
|
void |
setLevel(int level)
|
void |
setMaxThread(int maxThread)
|
void |
setName(java.lang.String name)
|
void |
setPassChainId(int newChain)
|
void |
setPassNotify(int notify)
|
void |
setProjectId(int newProjectId)
|
void |
setRunLimit(int newRunLimit)
|
void |
setSelectorId(java.lang.String selectorId)
|
void |
setStartNotify(int notify)
|
void |
setSteps(java.util.List<StepDBO> newSteps)
Completely replaces the current step list for this project. |
void |
setSticky(boolean sticky)
|
void |
setTag(java.lang.String tag)
|
void |
setTagSync(int tagSync)
|
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.GeoAwareDBObject |
---|
getGeoId, setGeoId |
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, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String TYPE_KEY
public static final java.lang.Class<ProjectDBO> CLASS
public static final char ACTIVE_YES
public static final char ACTIVE_NO
public static final char STICKY_YES
public static final char STICKY_NO
Constructor Detail |
---|
public ProjectDBO()
Method Detail |
---|
public java.lang.String getTypeKey()
DBObject
getTypeKey
in class DBObject
public boolean isLive()
DBObject
isLive
in class DBObject
public boolean getActive()
public java.lang.String getBuildClass()
public int getEnvironmentId()
public int getRunLimit()
public int getFailChainId()
public int getFailNotify()
public int getLevel()
public int getMaxThread()
public java.lang.String getName()
public int getPassChainId()
public int getPassNotify()
public int getProjectId()
public java.lang.String getSelectorId()
public int getStartNotify()
public boolean getSticky()
public java.lang.String getTag()
public int getTagSync()
public void setActive(boolean active)
public void setBuildClass(java.lang.String buildClass)
public void setEnvironmentId(int environmentId)
public void setRunLimit(int newRunLimit)
public void setFailChainId(int newChain)
public void setFailNotify(int notify)
public void setLevel(int level)
public void setMaxThread(int maxThread)
public void setName(java.lang.String name)
public void setPassChainId(int newChain)
public void setPassNotify(int notify)
public void setProjectId(int newProjectId)
public void setSelectorId(java.lang.String selectorId)
public void setStartNotify(int notify)
public void setSticky(boolean sticky)
public void setTag(java.lang.String tag)
public void setTagSync(int tagSync)
public int hashCode()
hashCode
in class java.lang.Object
public java.lang.String toString()
toString
in class java.lang.Object
public ProjectDBO 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 ProjectDBO clone()
clone
in class java.lang.Object
public void addStep(StepDBO newStep)
newStep
- public void addStep(StepDBO newStep, int index) throws APIException
newStep
- index
-
APIException
public StepDBO removeStep(int index) throws APIException
index
- the 0-based index of the step within the
project's step list
APIException
public StepDBO removeStep(java.lang.String stepUid)
stepUid
- the step's unique ID
public void copyStep(int fromIndex, java.lang.String newStepUid) throws APIException
fromIndex
- The 0-based index of the step to copynewStepUid
- The unique ID to assign to the copy
APIException
public void copyStep(int fromIndex, int toIndex, java.lang.String newStepUid) throws APIException
fromIndex
- The 0-based index of the step to copytoIndex
- The 0-based index at which to place the new
step. If the value would place the copied step past the end
of the list, then it is placed at the end of the list.newStepUid
- The unique ID to assign to the copy
APIException
public void moveStep(int fromIndex, int toIndex) throws APIException
fromIndex
- The 0-based original index of the steptoIndex
- The 0-based index at which the step will
be re-inserted. If this value would move the step past the
end of the list, then the step is moved to the end. If this
value is the same as the fromIndex, then no changes
are made.
APIException
public java.util.List<StepDBO> getSteps()
public StepDBO getStep(java.lang.String uid)
uid
- the unique ID
of the step to find
public StepDBO getStep(int index)
index
- the 0-based index of the step
public void setSteps(java.util.List<StepDBO> newSteps)
newSteps
- the new step list
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |