strutsviewactioncommand.html

门户开发

</TABLE>
&nbsp;
<P>

<!-- ============ FIELD DETAIL =========== -->

<A NAME="field_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Field Detail</B></FONT></TD>
</TR>
</TABLE>

<A NAME="URI"><!-- --></A><H3>
URI</H3>
<PRE>
protected static final java.lang.String <B>URI</B></PRE>
<DL>
<DD>Name of request attribute for the URI string.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.ibm.portal.struts.command.StrutsViewActionCommand.URI">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="messages"><!-- --></A><H3>
messages</H3>
<PRE>
protected static org.apache.struts.util.MessageResources <B>messages</B></PRE>
<DL>
<DD>The message resources for the Struts Portlet Framework.
<P>
<DL>
</DL>
</DL>

<!-- ========= CONSTRUCTOR DETAIL ======== -->

<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TD>
</TR>
</TABLE>

<A NAME="StrutsViewActionCommand()"><!-- --></A><H3>
StrutsViewActionCommand</H3>
<PRE>
public <B>StrutsViewActionCommand</B>()</PRE>
<DL>
<DD>Constructs the StrutsViewActionCommand object. The URI should be set 
 through the setUri method if this constructor is used.
<P>
</DL>
<HR>

<A NAME="StrutsViewActionCommand(java.lang.String, javax.portlet.PortletRequest)"><!-- --></A><H3>
StrutsViewActionCommand</H3>
<PRE>
public <B>StrutsViewActionCommand</B>(java.lang.String&nbsp;uri,
                               javax.portlet.PortletRequest&nbsp;request)</PRE>
<DL>
<DD>Construct the StrutsViewActionCommand object. The URI is the path for a 
 Struts action and matches the configured Struts servlet mapping. 
 The command is typically created in the action phase of Portal so a 
 PortletRequest object is expected.
<P>
<DT><B>Parameters:</B><DD><CODE>uri</CODE> - the URI path to the JSP<DD><CODE>request</CODE> - The request object to save context information from</DL>

<!-- ============ METHOD DETAIL ========== -->

<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Method Detail</B></FONT></TD>
</TR>
</TABLE>

<A NAME="getUri(javax.portlet.PortletRequest)"><!-- --></A><H3>
getUri</H3>
<PRE>
public java.lang.String <B>getUri</B>(javax.portlet.PortletRequest&nbsp;request)</PRE>
<DL>
<DD>Returns the URI. The URI is the path for a Struts action and matches
 the configured Struts servlet mapping.
 The command is typically created in the action phase of Portal so a 
 PortletRequest object is expected.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>request</CODE> - the portlet request object
<DT><B>Returns:</B><DD>returns the URI</DL>
</DD>
</DL>
<HR>

<A NAME="setUri(javax.portlet.PortletRequest, java.lang.String)"><!-- --></A><H3>
setUri</H3>
<PRE>
public void <B>setUri</B>(javax.portlet.PortletRequest&nbsp;request,
                   java.lang.String&nbsp;uri)</PRE>
<DL>
<DD>Sets the URI for this command. The URI is a Struts action and matches
 the configured Struts servlet mapping.
 The command is typically created in the action phase of Portal so a 
 PortletRequest object is expected.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>request</CODE> - the portlet request object<DD><CODE>uri</CODE> - the URI for the JSP.</DL>
</DD>
</DL>
<HR>

<A NAME="execute(javax.portlet.RenderRequest, javax.portlet.RenderResponse, com.ibm.portal.struts.command.ViewCommandExecutionContext)"><!-- --></A><H3>
execute</H3>
<PRE>
public void <B>execute</B>(javax.portlet.RenderRequest&nbsp;request,
                    javax.portlet.RenderResponse&nbsp;response,
                    <A HREF="../../../../../com/ibm/portal/struts/command/ViewCommandExecutionContext.html" title="class in com.ibm.portal.struts.command">ViewCommandExecutionContext</A>&nbsp;executionContext)
             throws javax.portlet.PortletException</PRE>
<DL>
<DD>Executes the given command given the request and response objects. The execute
 method is always called in the render phase of Portal and therefore the RenderRequest and
 RenderResponse objects are expected.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../com/ibm/portal/struts/command/IViewCommand.html#execute(javax.portlet.RenderRequest, javax.portlet.RenderResponse, com.ibm.portal.struts.command.ViewCommandExecutionContext)">execute</A></CODE> in interface <CODE><A HREF="../../../../../com/ibm/portal/struts/command/IViewCommand.html" title="interface in com.ibm.portal.struts.command">IViewCommand</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../com/ibm/portal/struts/command/StrutsViewCommand.html#execute(javax.portlet.RenderRequest, javax.portlet.RenderResponse, com.ibm.portal.struts.command.ViewCommandExecutionContext)">execute</A></CODE> in class <CODE><A HREF="../../../../../com/ibm/portal/struts/command/StrutsViewCommand.html" title="class in com.ibm.portal.struts.command">StrutsViewCommand</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>request</CODE> - The request object<DD><CODE>response</CODE> - The response object<DD><CODE>executionContext</CODE> - the execution context object
<DT><B>Throws:</B>
<DD><CODE>javax.portlet.PortletException</CODE> - if the request cannot be fulfilled</DL>
</DD>
</DL>
<HR>

<A NAME="saveAttributes(javax.portlet.PortletRequest, com.ibm.portal.struts.command.ViewCommandExecutionContext)"><!-- --></A><H3>
saveAttributes</H3>
<PRE>
public void <B>saveAttributes</B>(javax.portlet.PortletRequest&nbsp;request,
                           <A HREF="../../../../../com/ibm/portal/struts/command/ViewCommandExecutionContext.html" title="class in com.ibm.portal.struts.command">ViewCommandExecutionContext</A>&nbsp;executionContext)</PRE>
<DL>
<DD>Saves the attributes specific to action rendering.
<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../com/ibm/portal/struts/command/StrutsViewCommand.html#saveAttributes(javax.portlet.PortletRequest, com.ibm.portal.struts.command.ViewCommandExecutionContext)">saveAttributes</A></CODE> in class <CODE><A HREF="../../../../../com/ibm/portal/struts/command/StrutsViewCommand.html" title="class in com.ibm.portal.struts.command">StrutsViewCommand</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>request</CODE> - the request object<DD><CODE>executionContext</CODE> - the context object</DL>
</DD>
</DL>
<HR>

<A NAME="addAttributeNameToSave(java.lang.String)"><!-- --></A><H3>
addAttributeNameToSave</H3>
<PRE>
public static void <B>addAttributeNameToSave</B>(java.lang.String&nbsp;attributeName)</PRE>
<DL>
<DD>Adds the name of an attribute from the object request that needs to be 
 saved if present for the execution of the IViewCommand in Portal's
 render phase.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>attributeName</CODE> - the name of the attribute</DL>
</DD>
</DL>
<HR>

<A NAME="removeAttributeNameToSave(java.lang.String)"><!-- --></A><H3>
removeAttributeNameToSave</H3>
<PRE>
public static void <B>removeAttributeNameToSave</B>(java.lang.String&nbsp;attributeName)</PRE>
<DL>
<DD>Removes the name of an attribute from the list of attribute names to 
 save.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>attributeName</CODE> - the name of the attribute</DL>
</DD>
</DL>
<HR>

<A NAME="addAttributeTypeToSave(java.lang.Class)"><!-- --></A><H3>
addAttributeTypeToSave</H3>
<PRE>
public static void <B>addAttributeTypeToSave</B>(java.lang.Class&nbsp;attributeType)</PRE>
<DL>
<DD>Adds the class type of an attribute from the object request that needs to be 
 saved if present for the execution of the IViewCommand in Portal's 
 render phase.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>attributeType</CODE> - the attribute type</DL>
</DD>
</DL>
<HR>

<A NAME="removeAttributeTypeToSave(java.lang.Class)"><!-- --></A><H3>
removeAttributeTypeToSave</H3>
<PRE>
public static void <B>removeAttributeTypeToSave</B>(java.lang.Class&nbsp;attributeType)</PRE>
<DL>
<DD>Removes the class type of the request attribute from the list of 
 attributes to save.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>attributeType</CODE> - the attribute type</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>


<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  <TR ALIGN="center" VALIGN="top">
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<A HREF="#main"><FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../serialized-form.html"><FONT CLASS="NavBarFont1"><B>Serialized</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../../com/ibm/portal/struts/command/StrutsFilteredViewCommand.html" title="class in com.ibm.portal.struts.command"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../../com/ibm/portal/struts/command/StrutsViewCommand.html" title="class in com.ibm.portal.struts.command"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="StrutsViewActionCommand.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
&nbsp;<SCRIPT type="text/javascript">
  <!--
  if(window==top) {
    document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
  }
  //-->
</SCRIPT>
<NOSCRIPT>
  <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>

</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->

<HR>

</BODY>
</HTML>