|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
java.lang.Objectorg.apache.torque.om.BaseObject
org.apache.turbine.services.schedule.BaseJobEntry
org.apache.turbine.services.schedule.JobEntry
This is a wrapper for a scheduled job. It is modeled after the Unix scheduler cron. Note: BaseJobEntry is generated by Torque at compile time, and is therefore NOT in CVS.
| Field Summary |
| Fields inherited from class org.apache.torque.om.BaseObject |
NEW_ID |
| Constructor Summary | |
JobEntry()
default constructor |
|
JobEntry(int sec,
int min,
int hour,
int wd,
int day_mo,
java.lang.String task)
Constuctor. |
|
| Method Summary | |
void |
calcRunTime()
Calculate how long before the next runtime. |
int |
compareTo(java.lang.Object je)
Used for ordering Jobentries Note: this comparator imposes orderings that are inconsistent with equals. |
java.lang.String |
getNextRunAsString()
Get the next runtime for this job as a String. |
java.util.Date |
getNextRunDate()
Gets the next runtime as a date |
long |
getNextRuntime()
Get the next runtime for this job as a long. |
boolean |
isActive()
Check to see if job is currently active/running |
void |
setActive(boolean isActive)
Sets whether the job is running. |
| Methods inherited from class org.apache.turbine.services.schedule.BaseJobEntry |
copy, copy, copy, copy, copyInto, copyInto, copyInto, copyInto, getByName, getByPeerName, getByPosition, getDayOfMonth, getEmail, getFieldNames, getHour, getJobId, getMinute, getPeer, getPrimaryKey, getProperty, getSecond, getTableMap, getTask, getWeekDay, save, save, save, setByName, setByPeerName, setByPosition, setDayOfMonth, setEmail, setHour, setJobId, setMinute, setPrimaryKey, setPrimaryKey, setProperty, setSecond, setTask, setWeekDay, toString |
| Methods inherited from class org.apache.torque.om.BaseObject |
equals, equals, getLog, hashCode, isModified, isNew, resetModified, setModified, setNew, setPrimaryKey |
| Methods inherited from class java.lang.Object |
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
| Constructor Detail |
public JobEntry()
public JobEntry(int sec,
int min,
int hour,
int wd,
int day_mo,
java.lang.String task)
throws TurbineException
sec - Value for entry "seconds".min - Value for entry "minutes".hour - Value for entry "hours".wd - Value for entry "week days".day_mo - Value for entry "month days".task - Task to execute.
TurbineException - a generic exception.| Method Detail |
public int compareTo(java.lang.Object je)
compareTo in interface java.lang.Comparableje - The first JobEntry object.
int indicating the result of the comparison.public void setActive(boolean isActive)
isActive - Whether the job is running.public boolean isActive()
public long getNextRuntime()
public java.util.Date getNextRunDate()
public java.lang.String getNextRunAsString()
public void calcRunTime()
throws TurbineException
TurbineException - a generic exception.
|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||