| <!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 Jun 15 16:53:35 PDT 2001 --> |
| <TITLE> |
| Apache Struts API Documentation: Class ActionMapping |
| </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="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"> |
| <A HREF="../../../../org/apache/struts/action/ActionForwards.html"><B>PREV CLASS</B></A> |
| <A HREF="../../../../org/apache/struts/action/ActionMappingBase.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="ActionMapping.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: INNER | <A HREF="#field_summary">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: <A HREF="#field_detail">FIELD</A> | <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.struts.action</FONT> |
| <BR> |
| Class ActionMapping</H2> |
| <PRE> |
| java.lang.Object |
| | |
| +--<B>org.apache.struts.action.ActionMapping</B> |
| </PRE> |
| <DL> |
| <DT><B>All Implemented Interfaces:</B> <DD>java.io.Serializable</DD> |
| </DL> |
| <DL> |
| <DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../org/apache/struts/action/ActionMappingBase.html">ActionMappingBase</A>, <A HREF="../../../../org/apache/struts/action/RequestActionMapping.html">RequestActionMapping</A>, <A HREF="../../../../org/apache/struts/action/SessionActionMapping.html">SessionActionMapping</A></DD> |
| </DL> |
| <HR> |
| <DL> |
| <DT>public class <B>ActionMapping</B><DT>extends java.lang.Object<DT>implements java.io.Serializable</DL> |
| |
| <P> |
| An <strong>ActionMapping</strong> represents the information that the |
| controller servlet, <code>ActionServlet</code>, knows about the mapping |
| of a particular request to an instance of a particular action class. |
| The mapping is passed to the <code>perform()</code> method of the action |
| class itself, enabling access to this information directly. |
| <p> |
| An <code>ActionMapping</code> has the following minimal set of properties. |
| Additional properties can be added by a subclass, simply by |
| providing appropriate public "getter" and "setter" methods. |
| <ul> |
| <li><em>actionClass</em> - Fully qualified Java class name of the |
| <code>Action</code> implementation class used by this mapping. This |
| property is required. <em>DEPRECATED - use <code>type</code> |
| instead</em>. |
| <li><strong>attribute</strong> - Name of the request-scope or |
| session-scope attribute under which our form bean is accessed, if it |
| is other than the bean's specified name. Replaces the old |
| <code>formAttribute</code> property. |
| <li><em>formAttribute</em> - Name of the session attribute under |
| which an <code>ActionForm</code> bean is created and/or updated for |
| this mapping. If not present, no <code>ActionForm</code> bean will |
| be maintained automatically. <em>DEPRECATED - use |
| <code>attribute</code> instead.</em> |
| <li><em>formClass</em> - Fully qualified Java class name of the |
| <code>ActionForm</code> implementation class used by this mapping |
| (if any). <em>DEPRECATED - use the <code>name</code> attribute |
| to look up the corresponding ActionFormBean information</em>. |
| <li><em>formPrefix</em> - Prefix used to match request parameter |
| names when populating the properties of our <code>ActionForm</code> |
| bean (if any). <em>DEPRECATED - use <code>prefix</code> |
| instead</em>. |
| <li><em>formScope</em> - Scope within which the form bean associated |
| with this mapping will be created or looked for. Valid values are |
| "request" or "session". <em>DEPRECATED - use <code>scope</code> |
| instead</em>. |
| <li><em>formSuffix</em> - Suffix used to match request parameter |
| names when populating the properties of our <code>ActionForm</code> |
| bean (if any). <em>DEPRECATED - use <code>suffix</code> |
| instead</em>. |
| <li><strong>forward</strong> - Context-relative path of the resource that |
| should serve this request (via a call to |
| <code>RequestDispatcher.forward()</code>) instead of instantiating the |
| Action class specified by the <code>type</code> property. |
| Exactly one of the <code>forward</code>, <code>include</code>, or |
| <code>type</code> properties must be specified. |
| <li><strong>forwards</strong> - The set of ActionForwards locally |
| associated with this mapping. |
| <li><strong>include</strong> - Context-relative path of the resource that |
| should serve this request (via a call to |
| <code>RequestDispatcher.include()</code>) instead of instantiating the |
| Action class specified by the <code>type</code> property. |
| Exactly one of the <code>forward</code>, <code>include</code>, or |
| <code>type</code> properties must be specified.</li> |
| <li><strong>input</strong> - Context-relative path of the input form |
| to which control should be returned if a validation error is |
| encountered. Replaces the old <code>inputForm</code> property. |
| <li><em>inputForm</em> - Context-relative path of the input form |
| to which control should be returned if a validation error is |
| encountered. <em>DEPRECATED - use <code>input</code> instead</em>. |
| <li><strong>mappings</strong> - The <code>ActionMappings</code> |
| collection of which we are a part. |
| <li><strong>name</strong> - Name of the form bean, if any, associated |
| with this action. |
| <li><strong>parameter</strong> - General purpose configuration parameter |
| that can be used to pass extra information to the <code>Action</code> |
| selected by this <code>ActionMapping</code>. |
| <li><strong>path</strong> - Request URI path used to select this mapping. |
| If extension mapping is used for the controller servlet, the extension |
| will be stripped before comparisons against this value are made. |
| <li><strong>prefix</strong> - Prefix used to match request parameter |
| names to form bean property names, if any. Replaces the old |
| <code>formPrefix</code> property. |
| <li><strong>scope</strong> - Identifier of the scope ("request" or |
| "session" within which the form bean, if any, associated with this |
| action will be created. Replaces the old <code>formScope</code> |
| attribute. |
| <li><strong>suffix</strong> - Suffix used to match request parameter |
| names when populating the properties of our <code>ActionForm</code> |
| bean (if any). Replaces the old <code>formSuffix</code> property. |
| <li><strong>type</strong> - Fully qualified Java class name of the |
| <code>Action</code> implementation class used by this mapping. |
| Replaces the old <code>actionClass</code> property. Exactly one of |
| the <code>forward</code>, <code>include</code>, or <code>type</code> |
| properties must be specified. |
| <li><strong>unknown</strong> - Set to <code>true</code> if this action |
| should be configured as the default for this application, to handle |
| all requests not handled by another action. Only one action can be |
| defined as a default within a single application. |
| <li><strong>validate</strong> - Set to <code>true</code> if the |
| <code>validate()</code> method of the form bean (if any) associated |
| with this mapping should be called. |
| </ul> |
| <P> |
| <DL> |
| <DT><B>Version: </B><DD>$Revision: 1.2 $ $Date$</DD> |
| <DT><B>Author: </B><DD>Craig R. McClanahan</DD> |
| <DT><B>See Also: </B><DD><A HREF="../../../../serialized-form.html#org.apache.struts.action.ActionMapping">Serialized Form</A></DL> |
| <HR> |
| |
| <P> |
| <!-- ======== INNER CLASS SUMMARY ======== --> |
| |
| |
| <!-- =========== FIELD SUMMARY =========== --> |
| |
| <A NAME="field_summary"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TD COLSPAN=2><FONT SIZE="+2"> |
| <B>Field Summary</B></FONT></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionMapping.html#attribute">attribute</A></B></CODE> |
| |
| <BR> |
| The name of the request-scope or session-scope attribute under which |
| our form bean, if any, will be created.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionMapping.html#forward">forward</A></B></CODE> |
| |
| <BR> |
| The context relative path of the servlet or JSP resource (to be called |
| via <code>RequestDispatcher.forward()</code>) that will process this |
| request, rather than instantiating and calling the Action class that is |
| specified by the <code>type</code> attribute.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected <A HREF="../../../../org/apache/struts/action/ActionForwards.html">ActionForwards</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionMapping.html#forwards">forwards</A></B></CODE> |
| |
| <BR> |
| The set of ActionForward objects associated with this mapping.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionMapping.html#include">include</A></B></CODE> |
| |
| <BR> |
| The context relative path of the servlet or JSP resource (to be called |
| via <code>RequestDispatcher.include()</code>) that will process this |
| request, rather than instantiating and calling the Action class that is |
| specified by the <code>type</code> attribute.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionMapping.html#input">input</A></B></CODE> |
| |
| <BR> |
| The context-relative path of the input form to which control should |
| be returned if a validation error is encountered.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected <A HREF="../../../../org/apache/struts/action/Action.html">Action</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionMapping.html#instance">instance</A></B></CODE> |
| |
| <BR> |
| The initialized <code>Action</code> instance for this mapping.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected <A HREF="../../../../org/apache/struts/action/ActionMappings.html">ActionMappings</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionMapping.html#mappings">mappings</A></B></CODE> |
| |
| <BR> |
| The <code>ActionMappings</code> collection of which we are a part.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionMapping.html#multipartClass">multipartClass</A></B></CODE> |
| |
| <BR> |
| The fully qualified class name of the <code>MultipartRequestHandler</code> |
| implementation class used to process multipart request data for this mapping</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionMapping.html#name">name</A></B></CODE> |
| |
| <BR> |
| The name of the form bean, if any, associated with this action.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionMapping.html#parameter">parameter</A></B></CODE> |
| |
| <BR> |
| General purpose configuration parameter for this mapping.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionMapping.html#path">path</A></B></CODE> |
| |
| <BR> |
| The context-relative path of the submitted request, starting with a |
| "/" character, and without the filename extension (if any), that is |
| mapped to this action.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionMapping.html#prefix">prefix</A></B></CODE> |
| |
| <BR> |
| The parameter name prefix used to select parameters for this action.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionMapping.html#scope">scope</A></B></CODE> |
| |
| <BR> |
| The identifier of the scope ("request" or "session") under which the |
| form bean associated with this mapping, if any, should be created.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionMapping.html#suffix">suffix</A></B></CODE> |
| |
| <BR> |
| The parameter name suffix used to select parameters for this action.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionMapping.html#type">type</A></B></CODE> |
| |
| <BR> |
| The fully qualified Java class name of the <code>Action</code> |
| implementation class to be used to process requests for this mapping.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionMapping.html#unknown">unknown</A></B></CODE> |
| |
| <BR> |
| Should this action be the default for this application?</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionMapping.html#validate">validate</A></B></CODE> |
| |
| <BR> |
| Should the validate() method of our form bean be called?</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/struts/action/ActionMapping.html#ActionMapping()">ActionMapping</A></B>()</CODE> |
| |
| <BR> |
| </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/struts/action/ActionMapping.html#addForward(org.apache.struts.action.ActionForward)">addForward</A></B>(<A HREF="../../../../org/apache/struts/action/ActionForward.html">ActionForward</A> forward)</CODE> |
| |
| <BR> |
| Add a new <code>ActionForward</code> associated with this mapping.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/struts/action/ActionForm.html">ActionForm</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionMapping.html#createFormInstance()">createFormInstance</A></B>()</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> <I>Creation of ActionForm instances is now the responsibility |
| of the controller servlet</I></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/struts/action/ActionForward.html">ActionForward</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionMapping.html#findForward(java.lang.String)">findForward</A></B>(java.lang.String name)</CODE> |
| |
| <BR> |
| Return the <code>ActionForward</code> with the specified name, |
| if any; otherwise return <code>null</code>.</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/struts/action/ActionMapping.html#findForwards()">findForwards</A></B>()</CODE> |
| |
| <BR> |
| Return the logical names of all locally defined forwards for this |
| mapping.</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/struts/action/ActionMapping.html#getActionClass()">getActionClass</A></B>()</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> <I>Use getType() instead</I></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/struts/action/ActionMapping.html#getAttribute()">getAttribute</A></B>()</CODE> |
| |
| <BR> |
| Return the attribute name for our form bean.</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/struts/action/ActionMapping.html#getFormAttribute()">getFormAttribute</A></B>()</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> <I>Use getAttribute() instead</I></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/struts/action/ActionMapping.html#getFormClass()">getFormClass</A></B>()</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> <I>Use the bean name to look up the corresponding |
| ActionFormBean instead</I></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/struts/action/ActionMapping.html#getFormPrefix()">getFormPrefix</A></B>()</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> <I>Use getPrefix() instead</I></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/struts/action/ActionMapping.html#getFormScope()">getFormScope</A></B>()</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> <I>Use getScope() instead</I></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/struts/action/ActionMapping.html#getFormSuffix()">getFormSuffix</A></B>()</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> <I>Use getSuffix() instead</I></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/struts/action/ActionMapping.html#getForward()">getForward</A></B>()</CODE> |
| |
| <BR> |
| Return the forward path for this mapping.</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/struts/action/ActionMapping.html#getInclude()">getInclude</A></B>()</CODE> |
| |
| <BR> |
| Return the include path for this mapping.</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/struts/action/ActionMapping.html#getInput()">getInput</A></B>()</CODE> |
| |
| <BR> |
| Return the input form path for this mapping.</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/struts/action/ActionMapping.html#getInputForm()">getInputForm</A></B>()</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> <I>Use getInput() instead</I></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/struts/action/ActionMappings.html">ActionMappings</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionMapping.html#getMappings()">getMappings</A></B>()</CODE> |
| |
| <BR> |
| Return the <code>ActionMappings</code> collection of which |
| we are a part.</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/struts/action/ActionMapping.html#getMultipartClass()">getMultipartClass</A></B>()</CODE> |
| |
| <BR> |
| Get the name of the class used to handle multipart request data</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/struts/action/ActionMapping.html#getName()">getName</A></B>()</CODE> |
| |
| <BR> |
| Return the name of the form bean for this mapping.</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/struts/action/ActionMapping.html#getParameter()">getParameter</A></B>()</CODE> |
| |
| <BR> |
| Return the general purpose configuation parameter for this mapping.</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/struts/action/ActionMapping.html#getPath()">getPath</A></B>()</CODE> |
| |
| <BR> |
| Return the request URI path used to select this mapping.</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/struts/action/ActionMapping.html#getPrefix()">getPrefix</A></B>()</CODE> |
| |
| <BR> |
| Return the parameter name prefix for this mapping.</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/struts/action/ActionMapping.html#getScope()">getScope</A></B>()</CODE> |
| |
| <BR> |
| Return the attribute scope for this mapping.</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/struts/action/ActionMapping.html#getSuffix()">getSuffix</A></B>()</CODE> |
| |
| <BR> |
| Return the parameter name suffix for this mapping.</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/struts/action/ActionMapping.html#getType()">getType</A></B>()</CODE> |
| |
| <BR> |
| Return the fully qualified Action class name.</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/struts/action/ActionMapping.html#getUnknown()">getUnknown</A></B>()</CODE> |
| |
| <BR> |
| Return the unknown flag for this mapping.</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/struts/action/ActionMapping.html#getValidate()">getValidate</A></B>()</CODE> |
| |
| <BR> |
| Return the validate flag for this mapping.</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/struts/action/ActionMapping.html#removeForward(org.apache.struts.action.ActionForward)">removeForward</A></B>(<A HREF="../../../../org/apache/struts/action/ActionForward.html">ActionForward</A> forward)</CODE> |
| |
| <BR> |
| Remove a <code>ActionForward</code> associated with this mapping.</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/struts/action/ActionMapping.html#setActionClass(java.lang.String)">setActionClass</A></B>(java.lang.String actionClass)</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> <I>Use setType(String) instead</I></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/struts/action/ActionMapping.html#setAttribute(java.lang.String)">setAttribute</A></B>(java.lang.String attribute)</CODE> |
| |
| <BR> |
| Set the attribute name for our form bean.</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/struts/action/ActionMapping.html#setFormAttribute(java.lang.String)">setFormAttribute</A></B>(java.lang.String formAttribute)</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> <I>Use setAttribute(String) instead</I></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/struts/action/ActionMapping.html#setFormClass(java.lang.String)">setFormClass</A></B>(java.lang.String formClass)</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> <I>Modify the corresponding ActionFormBean instead</I></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/struts/action/ActionMapping.html#setFormPrefix(java.lang.String)">setFormPrefix</A></B>(java.lang.String formPrefix)</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> <I>Use setPrefix(String) instead</I></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/struts/action/ActionMapping.html#setFormScope(java.lang.String)">setFormScope</A></B>(java.lang.String formScope)</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> <I>Use setScope(String) instead</I></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/struts/action/ActionMapping.html#setFormSuffix(java.lang.String)">setFormSuffix</A></B>(java.lang.String formSuffix)</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> <I>Use setSuffix(String) instead</I></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/struts/action/ActionMapping.html#setForward(java.lang.String)">setForward</A></B>(java.lang.String forward)</CODE> |
| |
| <BR> |
| Set the forward path for this mapping.</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/struts/action/ActionMapping.html#setInclude(java.lang.String)">setInclude</A></B>(java.lang.String include)</CODE> |
| |
| <BR> |
| Set the include path for this mapping.</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/struts/action/ActionMapping.html#setInput(java.lang.String)">setInput</A></B>(java.lang.String input)</CODE> |
| |
| <BR> |
| Set the input form path for this mapping.</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/struts/action/ActionMapping.html#setInputForm(java.lang.String)">setInputForm</A></B>(java.lang.String inputForm)</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> <I>Use setInput(String) instead</I></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/struts/action/ActionMapping.html#setMappings(org.apache.struts.action.ActionMappings)">setMappings</A></B>(<A HREF="../../../../org/apache/struts/action/ActionMappings.html">ActionMappings</A> mappings)</CODE> |
| |
| <BR> |
| Set the <code>ActionMappings</code> collection of which |
| we are a part.</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/struts/action/ActionMapping.html#setMultipartClass(java.lang.String)">setMultipartClass</A></B>(java.lang.String multipartClass)</CODE> |
| |
| <BR> |
| Set the name of the class used to handle multipart request data</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/struts/action/ActionMapping.html#setName(java.lang.String)">setName</A></B>(java.lang.String name)</CODE> |
| |
| <BR> |
| Set the name of the form bean for this mapping.</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/struts/action/ActionMapping.html#setParameter(java.lang.String)">setParameter</A></B>(java.lang.String parameter)</CODE> |
| |
| <BR> |
| Set the general purpose configuration parameter for this mapping.</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/struts/action/ActionMapping.html#setPath(java.lang.String)">setPath</A></B>(java.lang.String path)</CODE> |
| |
| <BR> |
| Set the request URI path used to select this mapping.</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/struts/action/ActionMapping.html#setPrefix(java.lang.String)">setPrefix</A></B>(java.lang.String prefix)</CODE> |
| |
| <BR> |
| Set the parameter name prefix for this mapping.</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/struts/action/ActionMapping.html#setScope(java.lang.String)">setScope</A></B>(java.lang.String scope)</CODE> |
| |
| <BR> |
| Set the attribute scope for this mapping.</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/struts/action/ActionMapping.html#setSuffix(java.lang.String)">setSuffix</A></B>(java.lang.String suffix)</CODE> |
| |
| <BR> |
| Set the parameter name suffix for this mapping.</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/struts/action/ActionMapping.html#setType(java.lang.String)">setType</A></B>(java.lang.String type)</CODE> |
| |
| <BR> |
| Set the fully qualified Action class name.</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/struts/action/ActionMapping.html#setUnknown(boolean)">setUnknown</A></B>(boolean unknown)</CODE> |
| |
| <BR> |
| Set the unknown flag for this mapping.</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/struts/action/ActionMapping.html#setValidate(boolean)">setValidate</A></B>(boolean validate)</CODE> |
| |
| <BR> |
| Set the validate flag for this mapping.</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/struts/action/ActionMapping.html#toString()">toString</A></B>()</CODE> |
| |
| <BR> |
| Return a String version of this mapping.</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><clinit>, clone, equals, finalize, getClass, hashCode, notify, notifyAll, registerNatives, wait, wait, wait</CODE></TD> |
| </TR> |
| </TABLE> |
| |
| <P> |
| |
| <!-- ============ FIELD DETAIL =========== --> |
| |
| <A NAME="field_detail"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TD COLSPAN=1><FONT SIZE="+2"> |
| <B>Field Detail</B></FONT></TD> |
| </TR> |
| </TABLE> |
| |
| <A NAME="attribute"><!-- --></A><H3> |
| attribute</H3> |
| <PRE> |
| protected java.lang.String <B>attribute</B></PRE> |
| <DL> |
| <DD>The name of the request-scope or session-scope attribute under which |
| our form bean, if any, will be created.</DL> |
| <HR> |
| |
| <A NAME="forward"><!-- --></A><H3> |
| forward</H3> |
| <PRE> |
| protected java.lang.String <B>forward</B></PRE> |
| <DL> |
| <DD>The context relative path of the servlet or JSP resource (to be called |
| via <code>RequestDispatcher.forward()</code>) that will process this |
| request, rather than instantiating and calling the Action class that is |
| specified by the <code>type</code> attribute.</DL> |
| <HR> |
| |
| <A NAME="forwards"><!-- --></A><H3> |
| forwards</H3> |
| <PRE> |
| protected <A HREF="../../../../org/apache/struts/action/ActionForwards.html">ActionForwards</A> <B>forwards</B></PRE> |
| <DL> |
| <DD>The set of ActionForward objects associated with this mapping.</DL> |
| <HR> |
| |
| <A NAME="include"><!-- --></A><H3> |
| include</H3> |
| <PRE> |
| protected java.lang.String <B>include</B></PRE> |
| <DL> |
| <DD>The context relative path of the servlet or JSP resource (to be called |
| via <code>RequestDispatcher.include()</code>) that will process this |
| request, rather than instantiating and calling the Action class that is |
| specified by the <code>type</code> attribute.</DL> |
| <HR> |
| |
| <A NAME="input"><!-- --></A><H3> |
| input</H3> |
| <PRE> |
| protected java.lang.String <B>input</B></PRE> |
| <DL> |
| <DD>The context-relative path of the input form to which control should |
| be returned if a validation error is encountered.</DL> |
| <HR> |
| |
| <A NAME="instance"><!-- --></A><H3> |
| instance</H3> |
| <PRE> |
| protected <A HREF="../../../../org/apache/struts/action/Action.html">Action</A> <B>instance</B></PRE> |
| <DL> |
| <DD>The initialized <code>Action</code> instance for this mapping.</DL> |
| <HR> |
| |
| <A NAME="mappings"><!-- --></A><H3> |
| mappings</H3> |
| <PRE> |
| protected <A HREF="../../../../org/apache/struts/action/ActionMappings.html">ActionMappings</A> <B>mappings</B></PRE> |
| <DL> |
| <DD>The <code>ActionMappings</code> collection of which we are a part.</DL> |
| <HR> |
| |
| <A NAME="multipartClass"><!-- --></A><H3> |
| multipartClass</H3> |
| <PRE> |
| protected java.lang.String <B>multipartClass</B></PRE> |
| <DL> |
| <DD>The fully qualified class name of the <code>MultipartRequestHandler</code> |
| implementation class used to process multipart request data for this mapping</DL> |
| <HR> |
| |
| <A NAME="name"><!-- --></A><H3> |
| name</H3> |
| <PRE> |
| protected java.lang.String <B>name</B></PRE> |
| <DL> |
| <DD>The name of the form bean, if any, associated with this action.</DL> |
| <HR> |
| |
| <A NAME="parameter"><!-- --></A><H3> |
| parameter</H3> |
| <PRE> |
| protected java.lang.String <B>parameter</B></PRE> |
| <DL> |
| <DD>General purpose configuration parameter for this mapping.</DL> |
| <HR> |
| |
| <A NAME="path"><!-- --></A><H3> |
| path</H3> |
| <PRE> |
| protected java.lang.String <B>path</B></PRE> |
| <DL> |
| <DD>The context-relative path of the submitted request, starting with a |
| "/" character, and without the filename extension (if any), that is |
| mapped to this action.</DL> |
| <HR> |
| |
| <A NAME="prefix"><!-- --></A><H3> |
| prefix</H3> |
| <PRE> |
| protected java.lang.String <B>prefix</B></PRE> |
| <DL> |
| <DD>The parameter name prefix used to select parameters for this action.</DL> |
| <HR> |
| |
| <A NAME="scope"><!-- --></A><H3> |
| scope</H3> |
| <PRE> |
| protected java.lang.String <B>scope</B></PRE> |
| <DL> |
| <DD>The identifier of the scope ("request" or "session") under which the |
| form bean associated with this mapping, if any, should be created.</DL> |
| <HR> |
| |
| <A NAME="suffix"><!-- --></A><H3> |
| suffix</H3> |
| <PRE> |
| protected java.lang.String <B>suffix</B></PRE> |
| <DL> |
| <DD>The parameter name suffix used to select parameters for this action.</DL> |
| <HR> |
| |
| <A NAME="type"><!-- --></A><H3> |
| type</H3> |
| <PRE> |
| protected java.lang.String <B>type</B></PRE> |
| <DL> |
| <DD>The fully qualified Java class name of the <code>Action</code> |
| implementation class to be used to process requests for this mapping.</DL> |
| <HR> |
| |
| <A NAME="unknown"><!-- --></A><H3> |
| unknown</H3> |
| <PRE> |
| protected boolean <B>unknown</B></PRE> |
| <DL> |
| <DD>Should this action be the default for this application?</DL> |
| <HR> |
| |
| <A NAME="validate"><!-- --></A><H3> |
| validate</H3> |
| <PRE> |
| protected boolean <B>validate</B></PRE> |
| <DL> |
| <DD>Should the validate() method of our form bean be called?</DL> |
| |
| <!-- ========= 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="ActionMapping()"><!-- --></A><H3> |
| ActionMapping</H3> |
| <PRE> |
| public <B>ActionMapping</B>()</PRE> |
| <DL> |
| </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"> |
| <B>Method Detail</B></FONT></TD> |
| </TR> |
| </TABLE> |
| |
| <A NAME="getActionClass()"><!-- --></A><H3> |
| getActionClass</H3> |
| <PRE> |
| public java.lang.String <B>getActionClass</B>()</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <I>Use getType() instead</I> |
| <P> |
| <DD>Return the action class name for this mapping.<DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setActionClass(java.lang.String)"><!-- --></A><H3> |
| setActionClass</H3> |
| <PRE> |
| public void <B>setActionClass</B>(java.lang.String actionClass)</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <I>Use setType(String) instead</I> |
| <P> |
| <DD>Set the action class name for this mapping.<DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>actionClass</CODE> - The new action class name</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getAttribute()"><!-- --></A><H3> |
| getAttribute</H3> |
| <PRE> |
| public java.lang.String <B>getAttribute</B>()</PRE> |
| <DL> |
| <DD>Return the attribute name for our form bean.<DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setAttribute(java.lang.String)"><!-- --></A><H3> |
| setAttribute</H3> |
| <PRE> |
| public void <B>setAttribute</B>(java.lang.String attribute)</PRE> |
| <DL> |
| <DD>Set the attribute name for our form bean.<DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>attribute</CODE> - The new attribute name</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getFormAttribute()"><!-- --></A><H3> |
| getFormAttribute</H3> |
| <PRE> |
| public java.lang.String <B>getFormAttribute</B>()</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <I>Use getAttribute() instead</I> |
| <P> |
| <DD>Return the form session attribute key for this mapping, if any.<DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setFormAttribute(java.lang.String)"><!-- --></A><H3> |
| setFormAttribute</H3> |
| <PRE> |
| public void <B>setFormAttribute</B>(java.lang.String formAttribute)</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <I>Use setAttribute(String) instead</I> |
| <P> |
| <DD>Set the form session attribute key for this mapping.<DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>formAttribute</CODE> - The new form session attribute key</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getFormClass()"><!-- --></A><H3> |
| getFormClass</H3> |
| <PRE> |
| public java.lang.String <B>getFormClass</B>()</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <I>Use the bean name to look up the corresponding |
| ActionFormBean instead</I> |
| <P> |
| <DD>Return the form class name for this mapping.<DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setFormClass(java.lang.String)"><!-- --></A><H3> |
| setFormClass</H3> |
| <PRE> |
| public void <B>setFormClass</B>(java.lang.String formClass)</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <I>Modify the corresponding ActionFormBean instead</I> |
| <P> |
| <DD>Set the form class name for this mapping.<DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>formClass</CODE> - The new form class name</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getFormPrefix()"><!-- --></A><H3> |
| getFormPrefix</H3> |
| <PRE> |
| public java.lang.String <B>getFormPrefix</B>()</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <I>Use getPrefix() instead</I> |
| <P> |
| <DD>Return the form parameter name prefix for this mapping.<DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setFormPrefix(java.lang.String)"><!-- --></A><H3> |
| setFormPrefix</H3> |
| <PRE> |
| public void <B>setFormPrefix</B>(java.lang.String formPrefix)</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <I>Use setPrefix(String) instead</I> |
| <P> |
| <DD>Set the form parameter name prefix for this mapping.<DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>formPrefix</CODE> - The new form prefix</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getFormScope()"><!-- --></A><H3> |
| getFormScope</H3> |
| <PRE> |
| public java.lang.String <B>getFormScope</B>()</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <I>Use getScope() instead</I> |
| <P> |
| <DD>Return the scope within which our form bean will be accessed.<DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setFormScope(java.lang.String)"><!-- --></A><H3> |
| setFormScope</H3> |
| <PRE> |
| public void <B>setFormScope</B>(java.lang.String formScope)</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <I>Use setScope(String) instead</I> |
| <P> |
| <DD>Set the scope within which our form bean will be accessed.<DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>formScope</CODE> - The new scope ("request" or "session")</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getFormSuffix()"><!-- --></A><H3> |
| getFormSuffix</H3> |
| <PRE> |
| public java.lang.String <B>getFormSuffix</B>()</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <I>Use getSuffix() instead</I> |
| <P> |
| <DD>Return the form parameter name suffix for this mapping.<DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setFormSuffix(java.lang.String)"><!-- --></A><H3> |
| setFormSuffix</H3> |
| <PRE> |
| public void <B>setFormSuffix</B>(java.lang.String formSuffix)</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <I>Use setSuffix(String) instead</I> |
| <P> |
| <DD>Set the form parameter name suffix for this mapping.<DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>formSuffix</CODE> - The new form suffix</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getForward()"><!-- --></A><H3> |
| getForward</H3> |
| <PRE> |
| public java.lang.String <B>getForward</B>()</PRE> |
| <DL> |
| <DD>Return the forward path for this mapping.<DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setForward(java.lang.String)"><!-- --></A><H3> |
| setForward</H3> |
| <PRE> |
| public void <B>setForward</B>(java.lang.String forward)</PRE> |
| <DL> |
| <DD>Set the forward path for this mapping.<DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>forward</CODE> - The forward path for this mapping</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getInclude()"><!-- --></A><H3> |
| getInclude</H3> |
| <PRE> |
| public java.lang.String <B>getInclude</B>()</PRE> |
| <DL> |
| <DD>Return the include path for this mapping.<DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setInclude(java.lang.String)"><!-- --></A><H3> |
| setInclude</H3> |
| <PRE> |
| public void <B>setInclude</B>(java.lang.String include)</PRE> |
| <DL> |
| <DD>Set the include path for this mapping.<DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>include</CODE> - The include path for this mapping</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getInput()"><!-- --></A><H3> |
| getInput</H3> |
| <PRE> |
| public java.lang.String <B>getInput</B>()</PRE> |
| <DL> |
| <DD>Return the input form path for this mapping.<DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setInput(java.lang.String)"><!-- --></A><H3> |
| setInput</H3> |
| <PRE> |
| public void <B>setInput</B>(java.lang.String input)</PRE> |
| <DL> |
| <DD>Set the input form path for this mapping.<DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>input</CODE> - The new input form path</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getInputForm()"><!-- --></A><H3> |
| getInputForm</H3> |
| <PRE> |
| public java.lang.String <B>getInputForm</B>()</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <I>Use getInput() instead</I> |
| <P> |
| <DD>Return the input form URI for this mapping.<DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setInputForm(java.lang.String)"><!-- --></A><H3> |
| setInputForm</H3> |
| <PRE> |
| public void <B>setInputForm</B>(java.lang.String inputForm)</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <I>Use setInput(String) instead</I> |
| <P> |
| <DD>Set the input form URI for this mapping.<DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>inputForm</CODE> - The new input form URI</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getMappings()"><!-- --></A><H3> |
| getMappings</H3> |
| <PRE> |
| public <A HREF="../../../../org/apache/struts/action/ActionMappings.html">ActionMappings</A> <B>getMappings</B>()</PRE> |
| <DL> |
| <DD>Return the <code>ActionMappings</code> collection of which |
| we are a part.<DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getMultipartClass()"><!-- --></A><H3> |
| getMultipartClass</H3> |
| <PRE> |
| public java.lang.String <B>getMultipartClass</B>()</PRE> |
| <DL> |
| <DD>Get the name of the class used to handle multipart request data<DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Returns:</B><DD>A fully qualified java class name representing the implementation of |
| MultipartRequestHandler to use.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setMappings(org.apache.struts.action.ActionMappings)"><!-- --></A><H3> |
| setMappings</H3> |
| <PRE> |
| public void <B>setMappings</B>(<A HREF="../../../../org/apache/struts/action/ActionMappings.html">ActionMappings</A> mappings)</PRE> |
| <DL> |
| <DD>Set the <code>ActionMappings</code> collection of which |
| we are a part.<DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>mappings</CODE> - The new ActionMappings collection</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setMultipartClass(java.lang.String)"><!-- --></A><H3> |
| setMultipartClass</H3> |
| <PRE> |
| public void <B>setMultipartClass</B>(java.lang.String multipartClass)</PRE> |
| <DL> |
| <DD>Set the name of the class used to handle multipart request data<DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>multipartClass</CODE> - The fully qualified class name representing the |
| MultipartRequestHandler class to use. If <code>null</code>, |
| the global class specified in "web.xml" will be used.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getName()"><!-- --></A><H3> |
| getName</H3> |
| <PRE> |
| public java.lang.String <B>getName</B>()</PRE> |
| <DL> |
| <DD>Return the name of the form bean for this mapping.<DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setName(java.lang.String)"><!-- --></A><H3> |
| setName</H3> |
| <PRE> |
| public void <B>setName</B>(java.lang.String name)</PRE> |
| <DL> |
| <DD>Set the name of the form bean for this mapping.<DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>name</CODE> - The new name</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getParameter()"><!-- --></A><H3> |
| getParameter</H3> |
| <PRE> |
| public java.lang.String <B>getParameter</B>()</PRE> |
| <DL> |
| <DD>Return the general purpose configuation parameter for this mapping.<DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setParameter(java.lang.String)"><!-- --></A><H3> |
| setParameter</H3> |
| <PRE> |
| public void <B>setParameter</B>(java.lang.String parameter)</PRE> |
| <DL> |
| <DD>Set the general purpose configuration parameter for this mapping.<DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>parameter</CODE> - The new configuration parameter</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getPath()"><!-- --></A><H3> |
| getPath</H3> |
| <PRE> |
| public java.lang.String <B>getPath</B>()</PRE> |
| <DL> |
| <DD>Return the request URI path used to select this mapping.<DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setPath(java.lang.String)"><!-- --></A><H3> |
| setPath</H3> |
| <PRE> |
| public void <B>setPath</B>(java.lang.String path)</PRE> |
| <DL> |
| <DD>Set the request URI path used to select this mapping.<DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>path</CODE> - The new request URI path</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getPrefix()"><!-- --></A><H3> |
| getPrefix</H3> |
| <PRE> |
| public java.lang.String <B>getPrefix</B>()</PRE> |
| <DL> |
| <DD>Return the parameter name prefix for this mapping.<DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setPrefix(java.lang.String)"><!-- --></A><H3> |
| setPrefix</H3> |
| <PRE> |
| public void <B>setPrefix</B>(java.lang.String prefix)</PRE> |
| <DL> |
| <DD>Set the parameter name prefix for this mapping.<DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>prefix</CODE> - The new parameter name prefix</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getScope()"><!-- --></A><H3> |
| getScope</H3> |
| <PRE> |
| public java.lang.String <B>getScope</B>()</PRE> |
| <DL> |
| <DD>Return the attribute scope for this mapping.<DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setScope(java.lang.String)"><!-- --></A><H3> |
| setScope</H3> |
| <PRE> |
| public void <B>setScope</B>(java.lang.String scope)</PRE> |
| <DL> |
| <DD>Set the attribute scope for this mapping.<DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>scope</CODE> - The new attribute scope</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getSuffix()"><!-- --></A><H3> |
| getSuffix</H3> |
| <PRE> |
| public java.lang.String <B>getSuffix</B>()</PRE> |
| <DL> |
| <DD>Return the parameter name suffix for this mapping.<DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setSuffix(java.lang.String)"><!-- --></A><H3> |
| setSuffix</H3> |
| <PRE> |
| public void <B>setSuffix</B>(java.lang.String suffix)</PRE> |
| <DL> |
| <DD>Set the parameter name suffix for this mapping.<DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>suffix</CODE> - The new parameter name suffix</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getType()"><!-- --></A><H3> |
| getType</H3> |
| <PRE> |
| public java.lang.String <B>getType</B>()</PRE> |
| <DL> |
| <DD>Return the fully qualified Action class name.<DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setType(java.lang.String)"><!-- --></A><H3> |
| setType</H3> |
| <PRE> |
| public void <B>setType</B>(java.lang.String type)</PRE> |
| <DL> |
| <DD>Set the fully qualified Action class name.<DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>type</CODE> - The new class name</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getUnknown()"><!-- --></A><H3> |
| getUnknown</H3> |
| <PRE> |
| public boolean <B>getUnknown</B>()</PRE> |
| <DL> |
| <DD>Return the unknown flag for this mapping.<DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setUnknown(boolean)"><!-- --></A><H3> |
| setUnknown</H3> |
| <PRE> |
| public void <B>setUnknown</B>(boolean unknown)</PRE> |
| <DL> |
| <DD>Set the unknown flag for this mapping.<DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>unknown</CODE> - The new unknown flag</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getValidate()"><!-- --></A><H3> |
| getValidate</H3> |
| <PRE> |
| public boolean <B>getValidate</B>()</PRE> |
| <DL> |
| <DD>Return the validate flag for this mapping.<DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setValidate(boolean)"><!-- --></A><H3> |
| setValidate</H3> |
| <PRE> |
| public void <B>setValidate</B>(boolean validate)</PRE> |
| <DL> |
| <DD>Set the validate flag for this mapping.<DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>validate</CODE> - The new validate flag</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="addForward(org.apache.struts.action.ActionForward)"><!-- --></A><H3> |
| addForward</H3> |
| <PRE> |
| public void <B>addForward</B>(<A HREF="../../../../org/apache/struts/action/ActionForward.html">ActionForward</A> forward)</PRE> |
| <DL> |
| <DD>Add a new <code>ActionForward</code> associated with this mapping.<DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>forward</CODE> - The ActionForward to be added</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="createFormInstance()"><!-- --></A><H3> |
| createFormInstance</H3> |
| <PRE> |
| public <A HREF="../../../../org/apache/struts/action/ActionForm.html">ActionForm</A> <B>createFormInstance</B>()</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <I>Creation of ActionForm instances is now the responsibility |
| of the controller servlet</I> |
| <P> |
| <DD>Create and return an initialized instance of our form class. If |
| instantiation fails for any reason, <code>null</code> is returned.<DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="findForward(java.lang.String)"><!-- --></A><H3> |
| findForward</H3> |
| <PRE> |
| public <A HREF="../../../../org/apache/struts/action/ActionForward.html">ActionForward</A> <B>findForward</B>(java.lang.String name)</PRE> |
| <DL> |
| <DD>Return the <code>ActionForward</code> with the specified name, |
| if any; otherwise return <code>null</code>. If there is no locally |
| defined forwarding for the specified name, but a global forwards |
| collection has been associated with this mapping, the global |
| collection will also be searched before returning.<DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>name</CODE> - Name of the forward entry to be returned</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="findForwards()"><!-- --></A><H3> |
| findForwards</H3> |
| <PRE> |
| public java.lang.String[] <B>findForwards</B>()</PRE> |
| <DL> |
| <DD>Return the logical names of all locally defined forwards for this |
| mapping. If there are no such forwards, a zero-length array |
| is returned.<DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="removeForward(org.apache.struts.action.ActionForward)"><!-- --></A><H3> |
| removeForward</H3> |
| <PRE> |
| public void <B>removeForward</B>(<A HREF="../../../../org/apache/struts/action/ActionForward.html">ActionForward</A> forward)</PRE> |
| <DL> |
| <DD>Remove a <code>ActionForward</code> associated with this mapping.<DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>forward</CODE> - The ActionForward to be removed</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="toString()"><!-- --></A><H3> |
| toString</H3> |
| <PRE> |
| public java.lang.String <B>toString</B>()</PRE> |
| <DL> |
| <DD>Return a String version of this mapping.<DD><DL> |
| <DT><B>Overrides:</B><DD><CODE>toString</CODE> in class <CODE>java.lang.Object</CODE></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> </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="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"> |
| <A HREF="../../../../org/apache/struts/action/ActionForwards.html"><B>PREV CLASS</B></A> |
| <A HREF="../../../../org/apache/struts/action/ActionMappingBase.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="ActionMapping.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: INNER | <A HREF="#field_summary">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: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <!-- =========== END OF NAVBAR =========== --> |
| |
| <HR> |
| Copyright © 2000-2001 - Apache Software Foundation |
| </BODY> |
| </HTML> |