| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd"> |
| <!--NewPage--> |
| <HTML> |
| <HEAD> |
| <!-- Generated by javadoc on Fri Aug 22 03:44:08 EDT 2003 --> |
| <TITLE> |
| ConfigHelperInterface (Apache Struts API Documentation) |
| </TITLE> |
| <META NAME="keywords" CONTENT="org.apache.struts.config.ConfigHelperInterface,ConfigHelperInterface interface"> |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> |
| </HEAD> |
| <SCRIPT> |
| function asd() |
| { |
| parent.document.title="ConfigHelperInterface (Apache Struts API Documentation)"; |
| } |
| </SCRIPT> |
| <BODY BGCOLOR="white" onload="asd();"> |
| |
| <!-- ========== START OF NAVBAR ========== --> |
| <A NAME="navbar_top"><!-- --></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0"> |
| <TR> |
| <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_top_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3"> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ConfigHelperInterface.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| PREV CLASS |
| <A HREF="../../../../org/apache/struts/config/ModuleConfig.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="ConfigHelperInterface.html" TARGET="_top"><B>NO FRAMES</B></A> |
| |
| <SCRIPT> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A> |
| </NOSCRIPT> |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | CONSTR | <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.config</FONT> |
| <BR> |
| Interface ConfigHelperInterface</H2> |
| <DL> |
| <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../org/apache/struts/config/ConfigHelper.html">ConfigHelper</A></DD> |
| </DL> |
| <HR> |
| <DL> |
| <DT>public interface <B>ConfigHelperInterface</B></DL> |
| |
| <P> |
| NOTE: THIS CLASS IS UNDER ACTIVE DEVELOPMENT. |
| THE CURRENT CODE IS WRITTEN FOR CLARITY NOT EFFICIENCY. |
| NOT EVERY API FUNCTION HAS BEEN IMPLEMENTED YET. |
| |
| A helper object to expose the Struts shared resources, |
| which are be stored in the application, session, or |
| request contexts, as appropriate. |
| |
| An instance should be created for each request |
| processed. The methods which return resources from |
| the request or session contexts are not thread-safe. |
| |
| Provided for use by other servlets in the application |
| so they can easily access the Struts shared resources. |
| |
| The resources are stored under attributes in the |
| application, session, or request contexts. |
| |
| The ActionConfig methods simply return the resources |
| from under the context and key used by the Struts |
| ActionServlet when the resources are created. |
| <P> |
| |
| <P> |
| <DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.1</DD> |
| <DT><B>Version:</B></DT> |
| <DD>$Revision: 1.1 $ $Date$</DD> |
| <DT><B>Author:</B></DT> |
| <DD>Ted Husted, Luis Arias <luis@elysia.com></DD> |
| </DL> |
| <HR> |
| |
| <P> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| |
| |
| <!-- =========== FIELD SUMMARY =========== --> |
| |
| |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| |
| |
| <!-- ========== 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> java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/config/ConfigHelperInterface.html#getAction(java.lang.String)">getAction</A></B>(java.lang.String path)</CODE> |
| |
| <BR> |
| Return the URL for the specified ActionMapping, |
| otherwise return <code>null</code>.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/struts/action/ActionErrors.html">ActionErrors</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/config/ConfigHelperInterface.html#getActionErrors()">getActionErrors</A></B>()</CODE> |
| |
| <BR> |
| The <code>org.apache.struts.action.ActionErrors</code> object, |
| for this request.</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/config/ConfigHelperInterface.html#getActionForm()">getActionForm</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/struts/action/ActionFormBeans.html">ActionFormBeans</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/config/ConfigHelperInterface.html#getActionFormBeans()">getActionFormBeans</A></B>()</CODE> |
| |
| <BR> |
| The <code>org.apache.struts.action.ActionFormBeans</code> collection |
| for this application.</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/config/ConfigHelperInterface.html#getActionForward(java.lang.String)">getActionForward</A></B>(java.lang.String name)</CODE> |
| |
| <BR> |
| Return the forwarding associated with the specified logical 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> <A HREF="../../../../org/apache/struts/action/ActionForwards.html">ActionForwards</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/config/ConfigHelperInterface.html#getActionForwards()">getActionForwards</A></B>()</CODE> |
| |
| <BR> |
| The <code>org.apache.struts.action.ActionForwards</code> collection |
| for this application.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/struts/action/ActionMapping.html">ActionMapping</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/config/ConfigHelperInterface.html#getActionMapping(java.lang.String)">getActionMapping</A></B>(java.lang.String path)</CODE> |
| |
| <BR> |
| Return the mapping associated with the specified request path, 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/config/ConfigHelperInterface.html#getActionMappingName(java.lang.String)">getActionMappingName</A></B>(java.lang.String action)</CODE> |
| |
| <BR> |
| Return the form action converted into an action mapping path.</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/config/ConfigHelperInterface.html#getActionMappings()">getActionMappings</A></B>()</CODE> |
| |
| <BR> |
| The context attributes key under which our |
| <code>org.apache.struts.action.ActionMappings</code> collection |
| is normally stored, unless overridden when initializing our |
| ActionServlet.</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/config/ConfigHelperInterface.html#getActionMappingURL(java.lang.String)">getActionMappingURL</A></B>(java.lang.String action)</CODE> |
| |
| <BR> |
| Return the form action converted into a server-relative URL.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/struts/action/ActionMessages.html">ActionMessages</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/config/ConfigHelperInterface.html#getActionMessages()">getActionMessages</A></B>()</CODE> |
| |
| <BR> |
| The <code>org.apache.struts.action.ActionFormBeans</code> collection |
| for this application.</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/config/ConfigHelperInterface.html#getBaseRef()">getBaseRef</A></B>()</CODE> |
| |
| <BR> |
| Renders the reference for a HTML <base> element</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> javax.sql.DataSource</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/config/ConfigHelperInterface.html#getDataSource()">getDataSource</A></B>()</CODE> |
| |
| <BR> |
| </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/config/ConfigHelperInterface.html#getEncodeURL(java.lang.String)">getEncodeURL</A></B>(java.lang.String url)</CODE> |
| |
| <BR> |
| Return the url encoded to maintain the user session, if any.</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/config/ConfigHelperInterface.html#getErrorOutput()">getErrorOutput</A></B>()</CODE> |
| |
| <BR> |
| Returns the errors.header, any errors, and the errors.footer.</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/config/ConfigHelperInterface.html#getErrorOutput(java.lang.String)">getErrorOutput</A></B>(java.lang.String property)</CODE> |
| |
| <BR> |
| Returns the errors.header, any errors, and the errors.footer.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.util.Iterator</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/config/ConfigHelperInterface.html#getErrors()">getErrors</A></B>()</CODE> |
| |
| <BR> |
| Return the error messages</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.util.Iterator</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/config/ConfigHelperInterface.html#getErrors(java.lang.String)">getErrors</A></B>(java.lang.String property)</CODE> |
| |
| <BR> |
| Return an ActionError for a property</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/config/ConfigHelperInterface.html#getErrorsEmpty()">getErrorsEmpty</A></B>()</CODE> |
| |
| <BR> |
| Return true if there are no errors queued</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/config/ConfigHelperInterface.html#getErrorSize()">getErrorSize</A></B>()</CODE> |
| |
| <BR> |
| Return the number of error messages.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/config/ConfigHelperInterface.html#getErrorSize(java.lang.String)">getErrorSize</A></B>(java.lang.String property)</CODE> |
| |
| <BR> |
| Return the number of error messages.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.lang.Throwable</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/config/ConfigHelperInterface.html#getException()">getException</A></B>()</CODE> |
| |
| <BR> |
| The runtime JspException that may be been thrown by a Struts tag |
| extension, or compatible presentation extension, and placed |
| in the request.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/struts/action/ActionFormBean.html">ActionFormBean</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/config/ConfigHelperInterface.html#getFormBean(java.lang.String)">getFormBean</A></B>(java.lang.String name)</CODE> |
| |
| <BR> |
| Return the form bean definition associated with the specified |
| logical 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/config/ConfigHelperInterface.html#getLink(java.lang.String)">getLink</A></B>(java.lang.String name)</CODE> |
| |
| <BR> |
| Return the path for the specified forward, |
| otherwise return <code>null</code>.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.util.Locale</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/config/ConfigHelperInterface.html#getLocale()">getLocale</A></B>()</CODE> |
| |
| <BR> |
| The <code>java.util.Locale</code> for the user, if any.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/struts/action/ActionMapping.html">ActionMapping</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/config/ConfigHelperInterface.html#getMapping()">getMapping</A></B>()</CODE> |
| |
| <BR> |
| The <code>org.apache.struts.ActionMapping</code> |
| instance for this request.</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/config/ConfigHelperInterface.html#getMessage(java.lang.String)">getMessage</A></B>(java.lang.String key)</CODE> |
| |
| <BR> |
| Return the localized message for the specified key, |
| 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/config/ConfigHelperInterface.html#getMessage(java.lang.String, java.lang.Object[])">getMessage</A></B>(java.lang.String key, |
| java.lang.Object[] args)</CODE> |
| |
| <BR> |
| Look up and return a message string, based on the specified parameters.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/struts/util/MessageResources.html">MessageResources</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/config/ConfigHelperInterface.html#getMessageResources()">getMessageResources</A></B>()</CODE> |
| |
| <BR> |
| The application resources for this application.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/struts/upload/MultipartRequestWrapper.html">MultipartRequestWrapper</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/config/ConfigHelperInterface.html#getMultipartRequestWrapper()">getMultipartRequestWrapper</A></B>()</CODE> |
| |
| <BR> |
| The multipart object for this request.</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/config/ConfigHelperInterface.html#getOrigRef()">getOrigRef</A></B>()</CODE> |
| |
| <BR> |
| Renders the reference for a HTML <base> element</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/config/ConfigHelperInterface.html#getServletMapping()">getServletMapping</A></B>()</CODE> |
| |
| <BR> |
| The path-mapped pattern (<code>/action/*</code>) or |
| extension mapped pattern ((<code>*.do</code>) |
| used to determine our Action URIs in this application.</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/config/ConfigHelperInterface.html#getToken()">getToken</A></B>()</CODE> |
| |
| <BR> |
| The transaction token stored in this session, if it is used.</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/config/ConfigHelperInterface.html#isMessage(java.lang.String)">isMessage</A></B>(java.lang.String key)</CODE> |
| |
| <BR> |
| Return true if a message string for the specified message key |
| is present for the user's Locale.</TD> |
| </TR> |
| </TABLE> |
| |
| <P> |
| |
| <!-- ============ FIELD DETAIL =========== --> |
| |
| |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| |
| |
| <!-- ============ 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="getDataSource()"><!-- --></A><H3> |
| getDataSource</H3> |
| <PRE> |
| public javax.sql.DataSource <B>getDataSource</B>()</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getActionMessages()"><!-- --></A><H3> |
| getActionMessages</H3> |
| <PRE> |
| public <A HREF="../../../../org/apache/struts/action/ActionMessages.html">ActionMessages</A> <B>getActionMessages</B>()</PRE> |
| <DL> |
| <DD>The <code>org.apache.struts.action.ActionFormBeans</code> collection |
| for this application. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getActionFormBeans()"><!-- --></A><H3> |
| getActionFormBeans</H3> |
| <PRE> |
| public <A HREF="../../../../org/apache/struts/action/ActionFormBeans.html">ActionFormBeans</A> <B>getActionFormBeans</B>()</PRE> |
| <DL> |
| <DD>The <code>org.apache.struts.action.ActionFormBeans</code> collection |
| for this application. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getActionForwards()"><!-- --></A><H3> |
| getActionForwards</H3> |
| <PRE> |
| public <A HREF="../../../../org/apache/struts/action/ActionForwards.html">ActionForwards</A> <B>getActionForwards</B>()</PRE> |
| <DL> |
| <DD>The <code>org.apache.struts.action.ActionForwards</code> collection |
| for this application. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getActionMappings()"><!-- --></A><H3> |
| getActionMappings</H3> |
| <PRE> |
| public <A HREF="../../../../org/apache/struts/action/ActionMappings.html">ActionMappings</A> <B>getActionMappings</B>()</PRE> |
| <DL> |
| <DD>The context attributes key under which our |
| <code>org.apache.struts.action.ActionMappings</code> collection |
| is normally stored, unless overridden when initializing our |
| ActionServlet. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getMessageResources()"><!-- --></A><H3> |
| getMessageResources</H3> |
| <PRE> |
| public <A HREF="../../../../org/apache/struts/util/MessageResources.html">MessageResources</A> <B>getMessageResources</B>()</PRE> |
| <DL> |
| <DD>The application resources for this application. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getServletMapping()"><!-- --></A><H3> |
| getServletMapping</H3> |
| <PRE> |
| public java.lang.String <B>getServletMapping</B>()</PRE> |
| <DL> |
| <DD>The path-mapped pattern (<code>/action/*</code>) or |
| extension mapped pattern ((<code>*.do</code>) |
| used to determine our Action URIs in this application. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getLocale()"><!-- --></A><H3> |
| getLocale</H3> |
| <PRE> |
| public java.util.Locale <B>getLocale</B>()</PRE> |
| <DL> |
| <DD>The <code>java.util.Locale</code> for the user, if any. |
| If a default locale object is not in the user's session, |
| the system default locale is returned. |
| If used, the user locale is typically set during login |
| processing under the key <code>Globals.LOCALE_KEY</code>. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getToken()"><!-- --></A><H3> |
| getToken</H3> |
| <PRE> |
| public java.lang.String <B>getToken</B>()</PRE> |
| <DL> |
| <DD>The transaction token stored in this session, if it is used. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getActionErrors()"><!-- --></A><H3> |
| getActionErrors</H3> |
| <PRE> |
| public <A HREF="../../../../org/apache/struts/action/ActionErrors.html">ActionErrors</A> <B>getActionErrors</B>()</PRE> |
| <DL> |
| <DD>The <code>org.apache.struts.action.ActionErrors</code> object, |
| for this request. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getException()"><!-- --></A><H3> |
| getException</H3> |
| <PRE> |
| public java.lang.Throwable <B>getException</B>()</PRE> |
| <DL> |
| <DD>The runtime JspException that may be been thrown by a Struts tag |
| extension, or compatible presentation extension, and placed |
| in the request. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getMultipartRequestWrapper()"><!-- --></A><H3> |
| getMultipartRequestWrapper</H3> |
| <PRE> |
| public <A HREF="../../../../org/apache/struts/upload/MultipartRequestWrapper.html">MultipartRequestWrapper</A> <B>getMultipartRequestWrapper</B>()</PRE> |
| <DL> |
| <DD>The multipart object for this request. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getMapping()"><!-- --></A><H3> |
| getMapping</H3> |
| <PRE> |
| public <A HREF="../../../../org/apache/struts/action/ActionMapping.html">ActionMapping</A> <B>getMapping</B>()</PRE> |
| <DL> |
| <DD>The <code>org.apache.struts.ActionMapping</code> |
| instance for this request. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="isMessage(java.lang.String)"><!-- --></A><H3> |
| isMessage</H3> |
| <PRE> |
| public boolean <B>isMessage</B>(java.lang.String key)</PRE> |
| <DL> |
| <DD>Return true if a message string for the specified message key |
| is present for the user's Locale. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>key</CODE> - Message key</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getActionForm()"><!-- --></A><H3> |
| getActionForm</H3> |
| <PRE> |
| public <A HREF="../../../../org/apache/struts/action/ActionForm.html">ActionForm</A> <B>getActionForm</B>()</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getFormBean(java.lang.String)"><!-- --></A><H3> |
| getFormBean</H3> |
| <PRE> |
| public <A HREF="../../../../org/apache/struts/action/ActionFormBean.html">ActionFormBean</A> <B>getFormBean</B>(java.lang.String name)</PRE> |
| <DL> |
| <DD>Return the form bean definition associated with the specified |
| logical name, if any; otherwise return <code>null</code>. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>name</CODE> - Logical name of the requested form bean definition</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getActionForward(java.lang.String)"><!-- --></A><H3> |
| getActionForward</H3> |
| <PRE> |
| public <A HREF="../../../../org/apache/struts/action/ActionForward.html">ActionForward</A> <B>getActionForward</B>(java.lang.String name)</PRE> |
| <DL> |
| <DD>Return the forwarding associated with the specified logical name, |
| if any; otherwise return <code>null</code>. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>name</CODE> - Logical name of the requested forwarding</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getActionMapping(java.lang.String)"><!-- --></A><H3> |
| getActionMapping</H3> |
| <PRE> |
| public <A HREF="../../../../org/apache/struts/action/ActionMapping.html">ActionMapping</A> <B>getActionMapping</B>(java.lang.String path)</PRE> |
| <DL> |
| <DD>Return the mapping associated with the specified request path, if any; |
| otherwise return <code>null</code>. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>path</CODE> - Request path for which a mapping is requested</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getActionMappingName(java.lang.String)"><!-- --></A><H3> |
| getActionMappingName</H3> |
| <PRE> |
| public java.lang.String <B>getActionMappingName</B>(java.lang.String action)</PRE> |
| <DL> |
| <DD>Return the form action converted into an action mapping path. The |
| value of the <code>action</code> property is manipulated as follows in |
| computing the name of the requested mapping: |
| <ul> |
| <li>Any filename extension is removed (on the theory that extension |
| mapping is being used to select the controller servlet).</li> |
| <li>If the resulting value does not start with a slash, then a |
| slash is prepended.</li> |
| </ul> |
| :FIXME: Bad assumption =:o) |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getActionMappingURL(java.lang.String)"><!-- --></A><H3> |
| getActionMappingURL</H3> |
| <PRE> |
| public java.lang.String <B>getActionMappingURL</B>(java.lang.String action)</PRE> |
| <DL> |
| <DD>Return the form action converted into a server-relative URL. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getEncodeURL(java.lang.String)"><!-- --></A><H3> |
| getEncodeURL</H3> |
| <PRE> |
| public java.lang.String <B>getEncodeURL</B>(java.lang.String url)</PRE> |
| <DL> |
| <DD>Return the url encoded to maintain the user session, if any. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getOrigRef()"><!-- --></A><H3> |
| getOrigRef</H3> |
| <PRE> |
| public java.lang.String <B>getOrigRef</B>()</PRE> |
| <DL> |
| <DD>Renders the reference for a HTML <base> element |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getBaseRef()"><!-- --></A><H3> |
| getBaseRef</H3> |
| <PRE> |
| public java.lang.String <B>getBaseRef</B>()</PRE> |
| <DL> |
| <DD>Renders the reference for a HTML <base> element |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getLink(java.lang.String)"><!-- --></A><H3> |
| getLink</H3> |
| <PRE> |
| public java.lang.String <B>getLink</B>(java.lang.String name)</PRE> |
| <DL> |
| <DD>Return the path for the specified forward, |
| otherwise return <code>null</code>. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>name</CODE> - Name given to local or global forward.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getMessage(java.lang.String)"><!-- --></A><H3> |
| getMessage</H3> |
| <PRE> |
| public java.lang.String <B>getMessage</B>(java.lang.String key)</PRE> |
| <DL> |
| <DD>Return the localized message for the specified key, |
| otherwise return <code>null</code>. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>key</CODE> - Message key</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getMessage(java.lang.String, java.lang.Object[])"><!-- --></A><H3> |
| getMessage</H3> |
| <PRE> |
| public java.lang.String <B>getMessage</B>(java.lang.String key, |
| java.lang.Object[] args)</PRE> |
| <DL> |
| <DD>Look up and return a message string, based on the specified parameters. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>key</CODE> - Message key to be looked up and returned<DD><CODE>args</CODE> - Replacement parameters for this message</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getAction(java.lang.String)"><!-- --></A><H3> |
| getAction</H3> |
| <PRE> |
| public java.lang.String <B>getAction</B>(java.lang.String path)</PRE> |
| <DL> |
| <DD>Return the URL for the specified ActionMapping, |
| otherwise return <code>null</code>. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>path</CODE> - Name given to local or global forward.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getErrorSize()"><!-- --></A><H3> |
| getErrorSize</H3> |
| <PRE> |
| public int <B>getErrorSize</B>()</PRE> |
| <DL> |
| <DD>Return the number of error messages. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getErrorsEmpty()"><!-- --></A><H3> |
| getErrorsEmpty</H3> |
| <PRE> |
| public boolean <B>getErrorsEmpty</B>()</PRE> |
| <DL> |
| <DD>Return true if there are no errors queued |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getErrors()"><!-- --></A><H3> |
| getErrors</H3> |
| <PRE> |
| public java.util.Iterator <B>getErrors</B>()</PRE> |
| <DL> |
| <DD>Return the error messages |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getErrorOutput()"><!-- --></A><H3> |
| getErrorOutput</H3> |
| <PRE> |
| public java.lang.String <B>getErrorOutput</B>()</PRE> |
| <DL> |
| <DD>Returns the errors.header, any errors, and the errors.footer. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getErrorSize(java.lang.String)"><!-- --></A><H3> |
| getErrorSize</H3> |
| <PRE> |
| public int <B>getErrorSize</B>(java.lang.String property)</PRE> |
| <DL> |
| <DD>Return the number of error messages. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>property</CODE> - Property name</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getErrorOutput(java.lang.String)"><!-- --></A><H3> |
| getErrorOutput</H3> |
| <PRE> |
| public java.lang.String <B>getErrorOutput</B>(java.lang.String property)</PRE> |
| <DL> |
| <DD>Returns the errors.header, any errors, and the errors.footer. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>property</CODE> - Property name</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getErrors(java.lang.String)"><!-- --></A><H3> |
| getErrors</H3> |
| <PRE> |
| public java.util.Iterator <B>getErrors</B>(java.lang.String property)</PRE> |
| <DL> |
| <DD>Return an ActionError for a property |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>property</CODE> - Property name</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=3 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="class-use/ConfigHelperInterface.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| PREV CLASS |
| <A HREF="../../../../org/apache/struts/config/ModuleConfig.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="ConfigHelperInterface.html" TARGET="_top"><B>NO FRAMES</B></A> |
| |
| <SCRIPT> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A> |
| </NOSCRIPT> |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <!-- =========== END OF NAVBAR =========== --> |
| |
| <HR> |
| Copyright © 2000-2003 - Apache Software Foundation |
| </BODY> |
| </HTML> |
