jobentry.html

turbine教程

<B>Method Detail</B></FONT></TD>
</TR>
</TABLE>

<A NAME="calcRunTime()"><!-- --></A><H3>
calcRunTime</H3>
<PRE>
public void <B>calcRunTime</B>()
                 throws java.lang.Exception</PRE>
<DL>
<DD>Calculate how long before the next runtime.<br>

 The runtime determines it's position in the job queue.
 Here's the logic:<br>

 1. Create a date the represents when this job is to run.<br>

 2. If this date has expired, them "roll" appropriate date
 fields forward to the next date.<br>

 3. Calculate the diff in time between the current time and the
 next run time.<br><DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Throws:</B><DD><CODE>Exception,</CODE> - a generic exception.</DL>
</DD>
</DL>
<HR>

<A NAME="getNextRuntime()"><!-- --></A><H3>
getNextRuntime</H3>
<PRE>
public long <B>getNextRuntime</B>()</PRE>
<DL>
<DD>Get the next runtime for this job as a long.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>The next run time as a long.</DL>
</DD>
</DL>
<HR>

<A NAME="getNextRunAsString()"><!-- --></A><H3>
getNextRunAsString</H3>
<PRE>
public java.lang.String <B>getNextRunAsString</B>()</PRE>
<DL>
<DD>Get the next runtime for this job as a String.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>The next run time as a String.</DL>
</DD>
</DL>
<HR>

<A NAME="setEmail(java.lang.String)"><!-- --></A><H3>
setEmail</H3>
<PRE>
public void <B>setEmail</B>(java.lang.String&nbsp;mail)</PRE>
<DL>
<DD>The address to send mail notifications to.  This just holds the
 address.  The ScheduledJob should handle actually sending the
 mail.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>mail</CODE> - The email address.</DL>
</DD>
</DL>
<HR>

<A NAME="getEmail()"><!-- --></A><H3>
getEmail</H3>
<PRE>
public java.lang.String <B>getEmail</B>()</PRE>
<DL>
<DD>Return the e-mail address for notification.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>The email address.</DL>
</DD>
</DL>
<HR>

<A NAME="getTask()"><!-- --></A><H3>
getTask</H3>
<PRE>
public java.lang.String <B>getTask</B>()</PRE>
<DL>
<DD>Return the task for this job.  A task name is the Class name of
 the ScheduledJob created by the programmer.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>A String with the name of the scheduled job.</DL>
</DD>
</DL>
<HR>

<A NAME="setTask(java.lang.String)"><!-- --></A><H3>
setTask</H3>
<PRE>
public void <B>setTask</B>(java.lang.String&nbsp;task)</PRE>
<DL>
<DD>Set the task name for this job.  A task name is the Class name
 of the ScheduledJob created by the programmer.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>task</CODE> - A String with the name of the job.</DL>
</DD>
</DL>
<HR>

<A NAME="getSecond()"><!-- --></A><H3>
getSecond</H3>
<PRE>
public int <B>getSecond</B>()</PRE>
<DL>
<DD>Get the value of second.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>Value of second.</DL>
</DD>
</DL>
<HR>

<A NAME="setSecond(int)"><!-- --></A><H3>
setSecond</H3>
<PRE>
public void <B>setSecond</B>(int&nbsp;v)</PRE>
<DL>
<DD>Set the value of second.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>v</CODE> - Value to assign to second.</DL>
</DD>
</DL>
<HR>

<A NAME="getMinute()"><!-- --></A><H3>
getMinute</H3>
<PRE>
public int <B>getMinute</B>()</PRE>
<DL>
<DD>Get the value of minute.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>Value of minute.</DL>
</DD>
</DL>
<HR>

<A NAME="setMinute(int)"><!-- --></A><H3>
setMinute</H3>
<PRE>
public void <B>setMinute</B>(int&nbsp;v)</PRE>
<DL>
<DD>Set the value of minute.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>v</CODE> - Value to assign to minute.</DL>
</DD>
</DL>
<HR>

<A NAME="getHour()"><!-- --></A><H3>
getHour</H3>
<PRE>
public int <B>getHour</B>()</PRE>
<DL>
<DD>Get the value of hour.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>Value of hour.</DL>
</DD>
</DL>
<HR>

<A NAME="setHour(int)"><!-- --></A><H3>
setHour</H3>
<PRE>
public void <B>setHour</B>(int&nbsp;v)</PRE>
<DL>
<DD>Set the value of hour.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>v</CODE> - Value to assign to hour.</DL>
</DD>
</DL>
<HR>

<A NAME="getWeekday()"><!-- --></A><H3>
getWeekday</H3>
<PRE>
public int <B>getWeekday</B>()</PRE>
<DL>
<DD>Get the value of weekday.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>Value of weekday.</DL>
</DD>
</DL>
<HR>

<A NAME="setWeekday(int)"><!-- --></A><H3>
setWeekday</H3>
<PRE>
public void <B>setWeekday</B>(int&nbsp;v)</PRE>
<DL>
<DD>Set the value of weekday.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>v</CODE> - Value to assign to weekday.</DL>
</DD>
</DL>
<HR>

<A NAME="getDay_of_month()"><!-- --></A><H3>
getDay_of_month</H3>
<PRE>
public int <B>getDay_of_month</B>()</PRE>
<DL>
<DD>Get the value of day_of_month.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>Value of day_of_month.</DL>
</DD>
</DL>
<HR>

<A NAME="setDay_of_month(int)"><!-- --></A><H3>
setDay_of_month</H3>
<PRE>
public void <B>setDay_of_month</B>(int&nbsp;v)</PRE>
<DL>
<DD>Set the value of day_of_month.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>v</CODE> - Value to assign to day_of_month.</DL>
</DD>
</DL>
<HR>

<A NAME="save()"><!-- --></A><H3>
save</H3>
<PRE>
public void <B>save</B>()
          throws java.lang.Exception</PRE>
<DL>
<DD>Self-preservation.<DD><DL>
<DT><B>Overrides:</B><DD><CODE>save</CODE> in class <CODE>org.apache.torque.om.BaseObject</CODE></DL>
</DD>
<DD><DL>
<DT><B>Throws:</B><DD><CODE>Exception,</CODE> - a generic exception.</DL>
</DD>
</DL>
<HR>

<A NAME="save(java.sql.Connection)"><!-- --></A><H3>
save</H3>
<PRE>
public void <B>save</B>(java.sql.Connection&nbsp;conn)
          throws java.lang.Exception</PRE>
<DL>
<DD>not implemented<DD><DL>
<DT><B>Overrides:</B><DD><CODE>save</CODE> in class <CODE>org.apache.torque.om.BaseObject</CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>conn</CODE> - &nbsp;<DT><B>Throws:</B><DD><CODE>java.lang.Exception</CODE> - &nbsp;</DL>
</DD>
</DL>
<HR>

<A NAME="save(java.lang.String)"><!-- --></A><H3>
save</H3>
<PRE>
public void <B>save</B>(java.lang.String&nbsp;dbname)
          throws java.lang.Exception</PRE>
<DL>
<DD>not implemented<DD><DL>
<DT><B>Overrides:</B><DD><CODE>save</CODE> in class <CODE>org.apache.torque.om.BaseObject</CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>dbname</CODE> - &nbsp;<DT><B>Throws:</B><DD><CODE>java.lang.Exception</CODE> - &nbsp;</DL>
</DD>
</DL>
<HR>

<A NAME="compareTo(java.lang.Object)"><!-- --></A><H3>
compareTo</H3>
<PRE>
public int <B>compareTo</B>(java.lang.Object&nbsp;je)</PRE>
<DL>
<DD>Used for ordering Jobentries
 Note: this comparator imposes orderings that are inconsistent with
 equals.<DD><DL>
<DT><B>Specified by: </B><DD><CODE>compareTo</CODE> in interface <CODE>java.lang.Comparable</CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>je</CODE> - The first <code>JobEntry</code> object.<DT><B>Returns:</B><DD>An <code>int</code> indicating the result of the comparison.</DL>
</DD>
</DL>
<HR>

<A NAME="equals(java.lang.Object)"><!-- --></A><H3>
equals</H3>
<PRE>
public boolean <B>equals</B>(java.lang.Object&nbsp;je)</PRE>
<DL>
<DD>Compare this Job with another.<DD><DL>
<DT><B>Overrides:</B><DD><CODE>equals</CODE> in class <CODE>org.apache.torque.om.BaseObject</CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>je</CODE> - The JobEntry object to compare to.<DT><B>Returns:</B><DD>True if they're the same.</DL>
</DD>
</DL>
<HR>

<A NAME="setActive(boolean)"><!-- --></A><H3>
setActive</H3>
<PRE>
public void <B>setActive</B>(boolean&nbsp;isActive)</PRE>
<DL>
<DD>Sets whether the job is running.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>isActive</CODE> - Whether the job is running.</DL>
</DD>
</DL>
<HR>

<A NAME="isActive()"><!-- --></A><H3>
isActive</H3>
<PRE>
public boolean <B>isActive</B>()</PRE>
<DL>
<DD>Check to see if job is currently active/running<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>true if job is currently geing run by the
  workerthread, otherwise false</DL>
</DD>
</DL>
<HR>

<A NAME="setProperty(java.util.Hashtable)"><!-- --></A><H3>
setProperty</H3>
<PRE>
public void <B>setProperty</B>(java.util.Hashtable&nbsp;prop)</PRE>
<DL>
<DD>Set job properties<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getProperty()"><!-- --></A><H3>
getProperty</H3>
<PRE>
public java.util.Hashtable <B>getProperty</B>()</PRE>
<DL>
<DD>Get extra job properties<DD><DL>
</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>

<!-- ========== START OF NAVBAR ========== -->
<A NAME="navbar_bottom"><!-- --></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_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>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/JobEntry.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;PREV CLASS&nbsp;
&nbsp;<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>  &nbsp;
&nbsp;<A HREF="JobEntry.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  SUMMARY: &nbsp;INNER&nbsp;|&nbsp;<A HREF="#fields_inherited_from_class_org.apache.torque.om.BaseObject">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: &nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->

<HR>
Copyright &copy; 2000-2002 Apache Software Foundation. All Rights Reserved.
</BODY>
</HTML>