|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.buildforge.services.client.dbo.Cron
public final class Cron
Field Summary | |
---|---|
static java.lang.Class<Cron> |
CLASS
|
Constructor Summary | |
---|---|
Cron(APIClientConnection conn)
|
Method Summary | |
---|---|
void |
activate()
Acticates this Cron object. |
void |
activate(CronDBO.Active active)
Sets the activation state of this Cron object to an explicit value of the allowed enumeration of activation values. |
Cron |
create()
Creates this Cron object in the database |
void |
deactivate()
Deactivates this Cron object. |
void |
delete()
Removes this Cron object from the database |
static void |
deleteById(APIClientConnection conn,
int cronId)
Removes the specified Cron object from the database |
static java.util.List<Cron> |
findAll(APIClientConnection conn)
Returns a List of all Cron objects in the database |
static Cron |
findById(APIClientConnection conn,
int cronId)
Retrieves a specific Cron object by identifier |
CronDBO.Active |
getActive()
Returns the activation state for this Cron object |
java.lang.String |
getBuildClass()
Returns the name of the class to use when running this scheduled build. |
int |
getCronId()
Returns the unique identifier for this Cron object. |
java.lang.String |
getDayOfMonth()
Returns the days of the month on which the build should run. |
java.lang.String |
getDayOfWeek()
Returns the days of the week on which the build should run. |
java.lang.String |
getDescription()
Returns the user-supplied description for the Cron object. |
int |
getEnvGroupId()
|
int |
getEnvironmentGroupId()
Returns the environment group id of the environment used when kicking off this scheduled build. |
java.lang.String |
getEnvironmentText()
Returns the text of the environment store |
java.lang.String |
getEnvText()
|
int |
getFired()
Returns a timestamp of the last time this Cron was executed. |
java.lang.String |
getHour()
Returns the hours (according to a 24 hour clock) during which the build should run. |
java.lang.String |
getMinute()
Returns the number of minutes past the hour at which the build should run. |
java.lang.String |
getMonth()
Returns the months during which the build should run. |
int |
getNextRun()
Returns the timestamp (seconds since epoch) of the next time at which the scheduler entry is expected to be run. |
long |
getNextRunInMillis()
Returns the timestamp (seconds since epoch) normally returned by getNextRun()
adjusted for long length by multiplying by 1000. |
int |
getOwnerId()
Returns the user id of the user that created this scheduler entry. |
int |
getProjectId()
Returns the project id of the project to be run by this sceduler entry. |
java.lang.String |
getSelectorId()
Returns the identifier of the Selector used to determine server to run this scheduled job |
void |
oneShot()
Activates this Cron object for the next evaluation. |
void |
setActive(CronDBO.Active active)
Sets the activation state for this Cron object |
void |
setBuildClass(java.lang.String buildClass)
Sets the name of the class to use when running this scheduled build. |
void |
setDayOfMonth(java.lang.String dayOfMonth)
Sets the days of the month on which the build should run. |
void |
setDayOfWeek(java.lang.String dayOfWeek)
Sets the days of the week on which the build should run. |
void |
setDescription(java.lang.String description)
Sets the user-supplied description for the Cron object. |
void |
setEnvGroupId(int groupId)
|
void |
setEnvironmentGroupId(int environmentGroupId)
Sets the environment group id of the environment used when kicking off this scheduled build. |
void |
setEnvironmentText(java.lang.String envText)
Sets the text of the environment store |
void |
setEnvText(java.lang.String envText)
|
void |
setHour(java.lang.String hour)
Sets the hours (according to a 24 hour clock) during which the build should run. |
void |
setMinute(java.lang.String minute)
Sets the number of minutes past the hour at which the build should run. |
void |
setMonth(java.lang.String month)
Sets the months during which the build should run. |
void |
setProjectId(int projectId)
Sets the project id of the project to be run by this sceduler entry. |
void |
setSelectorId(java.lang.String selectorId)
Sets the identifier of the Selector used to determine server to run this scheduled job. |
java.lang.String |
toString()
|
Cron |
update()
Commits the values in this Cron object to the database |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.Class<Cron> CLASS
Constructor Detail |
---|
public Cron(APIClientConnection conn)
Method Detail |
---|
public static java.util.List<Cron> findAll(APIClientConnection conn) throws java.io.IOException, ServiceException
conn
-
java.io.IOException
ServiceException
public static Cron findById(APIClientConnection conn, int cronId) throws java.io.IOException, ServiceException
conn
- cronId
- The identifier of the Cron object to retrieve
java.io.IOException
ServiceException
public void deactivate() throws java.io.IOException, ServiceException
java.io.IOException
ServiceException
public void activate() throws java.io.IOException, ServiceException
java.io.IOException
ServiceException
public void oneShot() throws java.io.IOException, ServiceException
java.io.IOException
ServiceException
public void activate(CronDBO.Active active) throws java.io.IOException, ServiceException
active
-
java.io.IOException
ServiceException
public Cron create() throws java.io.IOException, ServiceException
java.io.IOException
ServiceException
public Cron update() throws java.io.IOException, ServiceException
java.io.IOException
ServiceException
public void delete() throws java.io.IOException, ServiceException
java.io.IOException
ServiceException
public static void deleteById(APIClientConnection conn, int cronId) throws java.io.IOException, ServiceException
conn
- cronId
- The identifier of the Cron object to remove
java.io.IOException
ServiceException
public CronDBO.Active getActive()
public java.lang.String getBuildClass()
public int getCronId()
public java.lang.String getDayOfMonth()
public java.lang.String getDayOfWeek()
public java.lang.String getDescription()
public int getEnvironmentGroupId()
public java.lang.String getEnvironmentText()
public int getFired()
public java.lang.String getHour()
public java.lang.String getMinute()
public java.lang.String getMonth()
public int getNextRun()
Value | Meaning |
---|---|
0 | Not yet been calculated. This should be updated within 15 seconds if the scheduler is running. |
-1 | An invalid value was specified for one or more of the cron fields, preventing the proper calculation of the next run time. |
-2 | The cron fields specified will never be
matched. For example, if #month is 4 and
#dayOfMonth is 3 |
public long getNextRunInMillis()
getNextRun()
adjusted for long length by multiplying by 1000. This is purely for the convenience
of Date object creation and contains no additional resolution.
public int getOwnerId()
public int getProjectId()
public java.lang.String getSelectorId()
public void setActive(CronDBO.Active active)
active
- public void setBuildClass(java.lang.String buildClass)
buildClass
- public void setDayOfMonth(java.lang.String dayOfMonth)
dayOfMonth
- public void setDayOfWeek(java.lang.String dayOfWeek)
dayOfWeek
- public void setDescription(java.lang.String description)
description
- public void setEnvironmentGroupId(int environmentGroupId)
environmentGroupId
- public void setEnvironmentText(java.lang.String envText)
envText
- public void setHour(java.lang.String hour)
hour
- public void setMinute(java.lang.String minute)
minute
- public void setMonth(java.lang.String month)
month
- public void setProjectId(int projectId)
projectId
- public void setSelectorId(java.lang.String selectorId)
selectorId
- public int getEnvGroupId()
public java.lang.String getEnvText()
public void setEnvGroupId(int groupId)
public void setEnvText(java.lang.String envText)
public java.lang.String toString()
toString
in class java.lang.Object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |