| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!--NewPage--> |
| <HTML> |
| <HEAD> |
| <!-- Generated by javadoc (build 1.4.2) on Thu May 05 14:46:26 EDT 2005 --> |
| <TITLE> |
| IOptionalTask |
| </TITLE> |
| |
| <META NAME="keywords" CONTENT="org.eclipse.wst.server.core.IOptionalTask interface"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../apistyles.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| parent.document.title="IOptionalTask"; |
| } |
| </SCRIPT> |
| |
| </HEAD> |
| |
| <BODY BGCOLOR="white" onload="windowTitle();"> |
| |
| |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <A NAME="navbar_top"><!-- --></A> |
| <A HREF="#skip-navbar_top" title="Skip navigation links"></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| <TR> |
| <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_top_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| <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"> <A HREF="#main"><FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/IOptionalTask.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="../../../../../serialized-form.html"><FONT CLASS="NavBarFont1"><B>Serialized</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-files/index-1.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"> |
| <A HREF="../../../../../org/eclipse/wst/server/core/IModuleType.html" title="interface in org.eclipse.wst.server.core"><B>PREV CLASS</B></A> |
| <A HREF="../../../../../org/eclipse/wst/server/core/IProjectProperties.html" title="interface in org.eclipse.wst.server.core"><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="IOptionalTask.html" target="_top"><B>NO FRAMES</B></A> |
| <SCRIPT type="text/javascript"> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> |
| </NOSCRIPT> |
| |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_top"></A> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| |
| <HR> |
| <A NAME="main"></A> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <H2> |
| <FONT SIZE="-1"> |
| org.eclipse.wst.server.core</FONT> |
| <BR> |
| Interface IOptionalTask</H2> |
| <DL> |
| <DT><B>All Superinterfaces:</B> <DD><A HREF="../../../../../org/eclipse/wst/server/core/ITask.html" title="interface in org.eclipse.wst.server.core">ITask</A></DD> |
| </DL> |
| <HR> |
| <DL> |
| <DT>public interface <B>IOptionalTask</B><DT>extends <A HREF="../../../../../org/eclipse/wst/server/core/ITask.html" title="interface in org.eclipse.wst.server.core">ITask</A></DL> |
| |
| <P> |
| An optional task. |
| |
| [issue: EY It is not clear to me that when this task will be run. Is this task be used for |
| both the server task and the module task? Will the place where the |
| task is being run depends on the server, e.g. the TDC tasks for the v6 server should be run |
| after the server is started the modules are added to the server; however, the EJB deploy task |
| makes more sense to be run before adding the project to the server.] |
| <P> |
| |
| <P> |
| <DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.0</DD> |
| </DL> |
| <HR> |
| |
| <P> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| |
| |
| <!-- =========== FIELD SUMMARY =========== --> |
| |
| <A NAME="field_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN=2><FONT SIZE="+2"> |
| <B>Field Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/server/core/IOptionalTask.html#TASK_COMPLETED">TASK_COMPLETED</A></B></CODE> |
| |
| <BR> |
| Optional task status constant (value 1) indicating that the task is |
| completed.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/server/core/IOptionalTask.html#TASK_MANDATORY">TASK_MANDATORY</A></B></CODE> |
| |
| <BR> |
| Optional task status constant (value 4) indicating that the task must be |
| run.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/server/core/IOptionalTask.html#TASK_PREFERRED">TASK_PREFERRED</A></B></CODE> |
| |
| <BR> |
| Optional task status constant (value 3) indicating that the task should be |
| selected to be run by default.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/server/core/IOptionalTask.html#TASK_READY">TASK_READY</A></B></CODE> |
| |
| <BR> |
| Optional task status constant (value 2) indicating that the task is ready |
| to be run.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/server/core/IOptionalTask.html#TASK_UNNECESSARY">TASK_UNNECESSARY</A></B></CODE> |
| |
| <BR> |
| Optional task status constant (value 0) indicating that the task should |
| not be run.</TD> |
| </TR> |
| </TABLE> |
| |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| |
| |
| <!-- ========== METHOD SUMMARY =========== --> |
| |
| <A NAME="method_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN=2><FONT SIZE="+2"> |
| <B>Method Summary</B></FONT></TH> |
| </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/eclipse/wst/server/core/IOptionalTask.html#getOrder()">getOrder</A></B>()</CODE> |
| |
| <BR> |
| Returns the order (index/priority) of the task that will be run.</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/eclipse/wst/server/core/IOptionalTask.html#getStatus()">getStatus</A></B>()</CODE> |
| |
| <BR> |
| Returns the status of this task.</TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_org.eclipse.wst.server.core.ITask"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Methods inherited from interface org.eclipse.wst.server.core.<A HREF="../../../../../org/eclipse/wst/server/core/ITask.html" title="interface in org.eclipse.wst.server.core">ITask</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="../../../../../org/eclipse/wst/server/core/ITask.html#canUndo()">canUndo</A>, <A HREF="../../../../../org/eclipse/wst/server/core/ITask.html#execute(IProgressMonitor)">execute</A>, <A HREF="../../../../../org/eclipse/wst/server/core/ITask.html#getDescription()">getDescription</A>, <A HREF="../../../../../org/eclipse/wst/server/core/ITask.html#getName()">getName</A>, <A HREF="../../../../../org/eclipse/wst/server/core/ITask.html#getTaskModel()">getTaskModel</A>, <A HREF="../../../../../org/eclipse/wst/server/core/ITask.html#setTaskModel(org.eclipse.wst.server.core.TaskModel)">setTaskModel</A>, <A HREF="../../../../../org/eclipse/wst/server/core/ITask.html#undo()">undo</A></CODE></TD> |
| </TR> |
| </TABLE> |
| |
| <P> |
| |
| <!-- ============ FIELD DETAIL =========== --> |
| |
| <A NAME="field_detail"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TD COLSPAN=1><FONT SIZE="+2"> |
| <B>Field Detail</B></FONT></TD> |
| </TR> |
| </TABLE> |
| |
| <A NAME="TASK_UNNECESSARY"><!-- --></A><H3> |
| TASK_UNNECESSARY</H3> |
| <PRE> |
| public static final int <B>TASK_UNNECESSARY</B></PRE> |
| <DL> |
| <DD>Optional task status constant (value 0) indicating that the task should |
| not be run. |
| <P> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../../org/eclipse/wst/server/core/IOptionalTask.html#getStatus()"><CODE>getStatus()</CODE></A>, |
| <A HREF="../../../../../constant-values.html#org.eclipse.wst.server.core.IOptionalTask.TASK_UNNECESSARY">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="TASK_COMPLETED"><!-- --></A><H3> |
| TASK_COMPLETED</H3> |
| <PRE> |
| public static final int <B>TASK_COMPLETED</B></PRE> |
| <DL> |
| <DD>Optional task status constant (value 1) indicating that the task is |
| completed. |
| <P> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../../org/eclipse/wst/server/core/IOptionalTask.html#getStatus()"><CODE>getStatus()</CODE></A>, |
| <A HREF="../../../../../constant-values.html#org.eclipse.wst.server.core.IOptionalTask.TASK_COMPLETED">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="TASK_READY"><!-- --></A><H3> |
| TASK_READY</H3> |
| <PRE> |
| public static final int <B>TASK_READY</B></PRE> |
| <DL> |
| <DD>Optional task status constant (value 2) indicating that the task is ready |
| to be run. |
| <P> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../../org/eclipse/wst/server/core/IOptionalTask.html#getStatus()"><CODE>getStatus()</CODE></A>, |
| <A HREF="../../../../../constant-values.html#org.eclipse.wst.server.core.IOptionalTask.TASK_READY">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="TASK_PREFERRED"><!-- --></A><H3> |
| TASK_PREFERRED</H3> |
| <PRE> |
| public static final int <B>TASK_PREFERRED</B></PRE> |
| <DL> |
| <DD>Optional task status constant (value 3) indicating that the task should be |
| selected to be run by default. |
| <P> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../../org/eclipse/wst/server/core/IOptionalTask.html#getStatus()"><CODE>getStatus()</CODE></A>, |
| <A HREF="../../../../../constant-values.html#org.eclipse.wst.server.core.IOptionalTask.TASK_PREFERRED">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="TASK_MANDATORY"><!-- --></A><H3> |
| TASK_MANDATORY</H3> |
| <PRE> |
| public static final int <B>TASK_MANDATORY</B></PRE> |
| <DL> |
| <DD>Optional task status constant (value 4) indicating that the task must be |
| run. |
| <P> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../../org/eclipse/wst/server/core/IOptionalTask.html#getStatus()"><CODE>getStatus()</CODE></A>, |
| <A HREF="../../../../../constant-values.html#org.eclipse.wst.server.core.IOptionalTask.TASK_MANDATORY">Constant Field Values</A></DL> |
| </DL> |
| |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| |
| |
| <!-- ============ METHOD DETAIL ========== --> |
| |
| <A NAME="method_detail"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TD COLSPAN=1><FONT SIZE="+2"> |
| <B>Method Detail</B></FONT></TD> |
| </TR> |
| </TABLE> |
| |
| <A NAME="getStatus()"><!-- --></A><H3> |
| getStatus</H3> |
| <PRE> |
| public int <B>getStatus</B>()</PRE> |
| <DL> |
| <DD>Returns the status of this task. |
| |
| issue: EY Should this status can return any of the TASK_XXX? The TASK_XXX |
| looks like a mix of status, e.g. for TASK_COMPLETED and TASK_READY. The |
| other TASK_XXX look like a nature of the task, e.g. TASK_UNNECESSARY, |
| TASK_PREFERRED, TASK_MANDATORY. Is this being used for both status and |
| deciding whether the task should be shown? |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>one of the status of the task (<code>TASK_XXX</code>) |
| constants declared on <A HREF="../../../../../org/eclipse/wst/server/core/IOptionalTask.html" title="interface in org.eclipse.wst.server.core"><CODE>IOptionalTask</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getOrder()"><!-- --></A><H3> |
| getOrder</H3> |
| <PRE> |
| public int <B>getOrder</B>()</PRE> |
| <DL> |
| <DD>Returns the order (index/priority) of the task that will be run. The task with |
| a smaller order value will be run before the task with a bigger order value. |
| For tasks that have the same order value, the order of running those task are |
| not guaranteed. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the order (index/priority) of the task that will be run.</DL> |
| </DD> |
| </DL> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <HR> |
| |
| |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <A NAME="navbar_bottom"><!-- --></A> |
| <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| <TR> |
| <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_bottom_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| <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"> <A HREF="#main"><FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/IOptionalTask.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="../../../../../serialized-form.html"><FONT CLASS="NavBarFont1"><B>Serialized</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-files/index-1.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"> |
| <A HREF="../../../../../org/eclipse/wst/server/core/IModuleType.html" title="interface in org.eclipse.wst.server.core"><B>PREV CLASS</B></A> |
| <A HREF="../../../../../org/eclipse/wst/server/core/IProjectProperties.html" title="interface in org.eclipse.wst.server.core"><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="IOptionalTask.html" target="_top"><B>NO FRAMES</B></A> |
| <SCRIPT type="text/javascript"> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> |
| </NOSCRIPT> |
| |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_bottom"></A> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| |
| <HR> |
| |
| </BODY> |
| </HTML> |
