com.buildforge.services.common.dbo
Class CronDBO

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

public class CronDBO
extends DBObject

Database information representing a scheduler entry (cron).


Nested Class Summary
static class CronDBO.Active
          Indicates whether or not this scheduler entry is active.
 
Field Summary
static java.lang.String TYPE_KEY
           
 
Constructor Summary
CronDBO()
           
 
Method Summary
 CronDBO fromArray(java.lang.Object[] data)
          Deserialize the database object's settings from a request array.
 CronDBO.Active getActive()
           
 java.lang.String getBuildClass()
           
 int getCronId()
           
 java.lang.String getDayOfMonth()
           
 java.lang.String getDayOfWeek()
           
 java.lang.String getDescription()
           
 int getEnvironmentGroupId()
           
 java.lang.String getEnvKey()
           
 java.lang.String getEnvText()
           
 int getFired()
           
 java.lang.String getHour()
           
 java.lang.String getMinute()
           
 java.lang.String getMonth()
           
 int getNextRun()
           
 int getOwnerId()
           
 int getProjectId()
           
 java.lang.String getSelectorId()
           
 java.lang.String getTypeKey()
          Retrieve the key that should be used to look up the display name for a data type.
 boolean isLive()
          Checks whether or not the object is live.
 void setActive(CronDBO.Active active)
           
 void setBuildClass(java.lang.String buildClass)
           
 void setCronId(int cronId)
           
 void setDayOfMonth(java.lang.String dayOfMonth)
           
 void setDayOfWeek(java.lang.String dayOfWeek)
           
 void setDescription(java.lang.String description)
           
 void setEnvironmentGroupId(int environmentGroupId)
           
 void setEnvKey(java.lang.String environmentStoreKey)
           
 void setEnvText(java.lang.String environmentText)
           
 void setFired(int fired)
           
 void setHour(java.lang.String hour)
           
 void setMinute(java.lang.String minute)
           
 void setMonth(java.lang.String month)
           
 void setNextRun(int nextRun)
           
 void setOwnerId(int ownerId)
           
 void setProjectId(int projectId)
           
 void setSelectorId(java.lang.String selectorId)
           
 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
Constructor Detail

CronDBO

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

getActive

public CronDBO.Active getActive()

getBuildClass

public java.lang.String getBuildClass()

getCronId

public int getCronId()

getDayOfMonth

public java.lang.String getDayOfMonth()

getDayOfWeek

public java.lang.String getDayOfWeek()

getDescription

public java.lang.String getDescription()

getEnvironmentGroupId

public int getEnvironmentGroupId()

getEnvKey

public java.lang.String getEnvKey()

getEnvText

public java.lang.String getEnvText()

getFired

public int getFired()

getHour

public java.lang.String getHour()

getMinute

public java.lang.String getMinute()

getMonth

public java.lang.String getMonth()

getNextRun

public int getNextRun()

getOwnerId

public int getOwnerId()

getProjectId

public int getProjectId()

getSelectorId

public java.lang.String getSelectorId()

setActive

public void setActive(CronDBO.Active active)

setBuildClass

public void setBuildClass(java.lang.String buildClass)

setCronId

public void setCronId(int cronId)

setDayOfMonth

public void setDayOfMonth(java.lang.String dayOfMonth)

setDayOfWeek

public void setDayOfWeek(java.lang.String dayOfWeek)

setDescription

public void setDescription(java.lang.String description)

setEnvironmentGroupId

public void setEnvironmentGroupId(int environmentGroupId)

setEnvKey

public void setEnvKey(java.lang.String environmentStoreKey)

setEnvText

public void setEnvText(java.lang.String environmentText)

setFired

public void setFired(int fired)

setHour

public void setHour(java.lang.String hour)

setMinute

public void setMinute(java.lang.String minute)

setMonth

public void setMonth(java.lang.String month)

setNextRun

public void setNextRun(int nextRun)

setOwnerId

public void setOwnerId(int ownerId)

setProjectId

public void setProjectId(int projectId)

setSelectorId

public void setSelectorId(java.lang.String selectorId)

toString

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

fromArray

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