📄 jobentry.html
字号:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Frameset//EN""http://www.w3.org/TR/REC-html40/frameset.dtd"><!--NewPage--><HTML><HEAD><!-- Generated by javadoc on Fri Dec 06 19:57:09 CET 2002 --><TITLE>jakarta-turbine-2 2.2 API: Class JobEntry</TITLE><LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style"></HEAD><BODY BGCOLOR="white"><!-- ========== START OF NAVBAR ========== --><A NAME="navbar_top"><!-- --></A><TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0"><TR><TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"><A NAME="navbar_top_firstrow"><!-- --></A><TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3"> <TR ALIGN="center" VALIGN="top"> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/JobEntry.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> </TR></TABLE></TD><TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM></EM></TD></TR><TR><TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> PREV CLASS <A HREF="../../../../../org/apache/turbine/services/schedule/JobEntryPeer.html"><B>NEXT CLASS</B></A></FONT></TD><TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../../index.html" TARGET="_top"><B>FRAMES</B></A> <A HREF="JobEntry.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD></TR><TR><TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> SUMMARY: INNER | <A HREF="#fields_inherited_from_class_org.apache.torque.om.BaseObject">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD><TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD></TR></TABLE><!-- =========== END OF NAVBAR =========== --><HR><!-- ======== START OF CLASS DATA ======== --><H2><FONT SIZE="-1">org.apache.turbine.services.schedule</FONT><BR>Class JobEntry</H2><PRE>java.lang.Object | +--org.apache.torque.om.BaseObject | +--<B>org.apache.turbine.services.schedule.JobEntry</B></PRE><DL><DT><B>All Implemented Interfaces:</B> <DD>java.lang.Comparable, org.apache.torque.om.Persistent, java.io.Serializable</DD></DL><HR><DL><DT>public class <B>JobEntry</B><DT>extends org.apache.torque.om.BaseObject<DT>implements java.lang.Comparable</DL><P>This is a wrapper for a scheduled job. It is modeled after the Unix scheduler cron.<P><DL><DT><B>Version: </B><DD>$Id: JobEntry.java,v 1.8 2002/07/11 07:34:30 mpoeschl Exp $</DD><DT><B>Author: </B><DD><a href="mailto:mbryson@mont.mindspring.com">Dave Bryson</a></DD><DT><B>See Also: </B><DD><A HREF="../../../../../serialized-form.html#org.apache.turbine.services.schedule.JobEntry">Serialized Form</A></DL><HR><P><!-- ======== INNER CLASS SUMMARY ======== --><!-- =========== FIELD SUMMARY =========== --><A NAME="fields_inherited_from_class_org.apache.torque.om.BaseObject"><!-- --></A><TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"><TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"><TD><B>Fields inherited from class org.apache.torque.om.BaseObject</B></TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD><CODE>NEW_ID</CODE></TD></TR></TABLE> <!-- ======== CONSTRUCTOR SUMMARY ======== --><A NAME="constructor_summary"><!-- --></A><TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"><TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"><TD COLSPAN=2><FONT SIZE="+2"><B>Constructor Summary</B></FONT></TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD><CODE><B><A HREF="../../../../../org/apache/turbine/services/schedule/JobEntry.html#JobEntry()">JobEntry</A></B>()</CODE><BR> Default Constructor</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD><CODE><B><A HREF="../../../../../org/apache/turbine/services/schedule/JobEntry.html#JobEntry(int, int, int, int, int, java.lang.String)">JobEntry</A></B>(int sec, int min, int hour, int wd, int day_mo, java.lang.String task)</CODE><BR> Constuctor.</TD></TR></TABLE> <!-- ========== METHOD SUMMARY =========== --><A NAME="method_summary"><!-- --></A><TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"><TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"><TD COLSPAN=2><FONT SIZE="+2"><B>Method Summary</B></FONT></TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> void</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../org/apache/turbine/services/schedule/JobEntry.html#calcRunTime()">calcRunTime</A></B>()</CODE><BR> Calculate how long before the next runtime.<br> The runtime determines it's position in the job queue.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> int</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../org/apache/turbine/services/schedule/JobEntry.html#compareTo(java.lang.Object)">compareTo</A></B>(java.lang.Object je)</CODE><BR> Used for ordering Jobentries Note: this comparator imposes orderings that are inconsistent with equals.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> boolean</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../org/apache/turbine/services/schedule/JobEntry.html#equals(java.lang.Object)">equals</A></B>(java.lang.Object je)</CODE><BR> Compare this Job with another.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> int</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../org/apache/turbine/services/schedule/JobEntry.html#getDay_of_month()">getDay_of_month</A></B>()</CODE><BR> Get the value of day_of_month.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> java.lang.String</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../org/apache/turbine/services/schedule/JobEntry.html#getEmail()">getEmail</A></B>()</CODE><BR> Return the e-mail address for notification.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> int</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../org/apache/turbine/services/schedule/JobEntry.html#getHour()">getHour</A></B>()</CODE><BR> Get the value of hour.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> int</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../org/apache/turbine/services/schedule/JobEntry.html#getMinute()">getMinute</A></B>()</CODE><BR> Get the value of minute.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> java.lang.String</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../org/apache/turbine/services/schedule/JobEntry.html#getNextRunAsString()">getNextRunAsString</A></B>()</CODE><BR> Get the next runtime for this job as a String.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> long</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../org/apache/turbine/services/schedule/JobEntry.html#getNextRuntime()">getNextRuntime</A></B>()</CODE><BR> Get the next runtime for this job as a long.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> java.util.Hashtable</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../org/apache/turbine/services/schedule/JobEntry.html#getProperty()">getProperty</A></B>()</CODE><BR> Get extra job properties</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> int</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../org/apache/turbine/services/schedule/JobEntry.html#getSecond()">getSecond</A></B>()</CODE><BR> Get the value of second.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> java.lang.String</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../org/apache/turbine/services/schedule/JobEntry.html#getTask()">getTask</A></B>()</CODE><BR> Return the task for this job.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> int</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../org/apache/turbine/services/schedule/JobEntry.html#getWeekday()">getWeekday</A></B>()</CODE><BR> Get the value of weekday.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> boolean</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../org/apache/turbine/services/schedule/JobEntry.html#isActive()">isActive</A></B>()</CODE><BR> Check to see if job is currently active/running</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> void</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../org/apache/turbine/services/schedule/JobEntry.html#save()">save</A></B>()</CODE><BR> Self-preservation.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> void</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../org/apache/turbine/services/schedule/JobEntry.html#save(java.sql.Connection)">save</A></B>(java.sql.Connection conn)</CODE><BR> not implemented</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> void</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../org/apache/turbine/services/schedule/JobEntry.html#save(java.lang.String)">save</A></B>(java.lang.String dbname)</CODE><BR> not implemented</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> void</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../org/apache/turbine/services/schedule/JobEntry.html#setActive(boolean)">setActive</A></B>(boolean isActive)</CODE><BR> Sets whether the job is running.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> void</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../org/apache/turbine/services/schedule/JobEntry.html#setDay_of_month(int)">setDay_of_month</A></B>(int v)</CODE><BR> Set the value of day_of_month.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> void</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../org/apache/turbine/services/schedule/JobEntry.html#setEmail(java.lang.String)">setEmail</A></B>(java.lang.String mail)</CODE><BR> The address to send mail notifications to.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> void</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../org/apache/turbine/services/schedule/JobEntry.html#setHour(int)">setHour</A></B>(int v)</CODE><BR> Set the value of hour.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> void</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../org/apache/turbine/services/schedule/JobEntry.html#setMinute(int)">setMinute</A></B>(int v)</CODE><BR> Set the value of minute.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> void</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../org/apache/turbine/services/schedule/JobEntry.html#setProperty(java.util.Hashtable)">setProperty</A></B>(java.util.Hashtable prop)</CODE><BR> Set job properties</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> void</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../org/apache/turbine/services/schedule/JobEntry.html#setSecond(int)">setSecond</A></B>(int v)</CODE><BR> Set the value of second.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> void</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../org/apache/turbine/services/schedule/JobEntry.html#setTask(java.lang.String)">setTask</A></B>(java.lang.String task)</CODE><BR> Set the task name for this job.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> void</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../org/apache/turbine/services/schedule/JobEntry.html#setWeekday(int)">setWeekday</A></B>(int v)</CODE><BR> Set the value of weekday.</TD></TR></TABLE> <A NAME="methods_inherited_from_class_org.apache.torque.om.BaseObject"><!-- --></A><TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"><TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"><TD><B>Methods inherited from class org.apache.torque.om.BaseObject</B></TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD><CODE>equals, getByName, getByPeerName, getByPosition, getCategory, getPrimaryKey, getPrimaryKeyAsBigDecimal, getPrimaryKeyAsInt, getPrimaryKeyAsLong, getPrimaryKeyAsString, hashCode, isModified, isNew, log, resetModified, setModified, setNew, setPrimaryKey, setPrimaryKey, setPrimaryKey, setPrimaryKey, setPrimaryKey</CODE></TD></TR></TABLE> <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A><TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"><TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"><TD><B>Methods inherited from class java.lang.Object</B></TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD><CODE>clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait</CODE></TD></TR></TABLE> <P><!-- ============ FIELD DETAIL =========== --><!-- ========= CONSTRUCTOR DETAIL ======== --><A NAME="constructor_detail"><!-- --></A><TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"><TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"><TD COLSPAN=1><FONT SIZE="+2"><B>Constructor Detail</B></FONT></TD></TR></TABLE><A NAME="JobEntry()"><!-- --></A><H3>JobEntry</H3><PRE>public <B>JobEntry</B>()</PRE><DL><DD>Default Constructor</DL><HR><A NAME="JobEntry(int, int, int, int, int, java.lang.String)"><!-- --></A><H3>JobEntry</H3><PRE>public <B>JobEntry</B>(int sec, int min, int hour, int wd, int day_mo, java.lang.String task) throws java.lang.Exception</PRE><DL><DD>Constuctor. Schedule a job to run on a certain point of time.<br> Example 1: Run the DefaultScheduledJob at 8:00am every 15th of the month - <br> JobEntry je = new JobEntry(0,0,8,15,"DefaultScheduledJob");<br> Example 2: Run the DefaultScheduledJob at 8:00am every day - <br> JobEntry je = new JobEntry(0,0,8,-1,"DefaultScheduledJob");<br> Example 3: Run the DefaultScheduledJob every 2 hours. - <br> JobEntry je = new JobEntry(0,120,-1,-1,"DefaultScheduledJob");<br> Example 4: Run the DefaultScheduledJob every 30 seconds. - <br> JobEntry je = new JobEntry(30,-1,-1,-1,"DefaultScheduledJob");<br><DD><DL><DT><B>Parameters:</B><DD><CODE>sec</CODE> - Value for entry "seconds".<DD><CODE>min</CODE> - Value for entry "minutes".<DD><CODE>hour</CODE> - Value for entry "hours".<DD><CODE>wd</CODE> - Value for entry "week days".<DD><CODE>day_mo</CODE> - Value for entry "month days".<DD><CODE>task</CODE> - Task to execute.<DT><B>Throws:</B><DD><CODE>Exception,</CODE> - a generic exception.</DL></DD></DL><!-- ============ METHOD DETAIL ========== --><A NAME="method_detail"><!-- --></A><TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"><TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"><TD COLSPAN=1><FONT SIZE="+2">⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -