wpsstrutsviewcommand.html

门户开发

<DD><DL>
</DL>
</DD>
<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 request that needs to be 
 saved if present for the execution of the IViewCommand in ortal's 
 render phase.
<P>
<DD><DL>
</DL>
</DD>
<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>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>attributeType</CODE> - the attribute type</DL>
</DD>
</DL>
<HR>

<A NAME="addParameterNameToSave(java.lang.String)"><!-- --></A><H3>
addParameterNameToSave</H3>
<PRE>
public static void <B>addParameterNameToSave</B>(java.lang.String&nbsp;parameterName)</PRE>
<DL>
<DD>Adds the name of an parameter 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>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>parameterName</CODE> - the name of the parameter</DL>
</DD>
</DL>
<HR>

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

<A NAME="getSavedCommand(org.apache.jetspeed.portlet.PortletRequest, com.ibm.wps.portlets.struts.ViewCommandExecutionContext)"><!-- --></A><H3>
getSavedCommand</H3>
<PRE>
public static <A HREF="../../../../../com/ibm/wps/portlets/struts/IViewCommand.html" title="interface in com.ibm.wps.portlets.struts">IViewCommand</A> <B>getSavedCommand</B>(<A HREF="../../../../../org/apache/jetspeed/portlet/PortletRequest.html" title="interface in org.apache.jetspeed.portlet">PortletRequest</A>&nbsp;pRequest,
                                           <A HREF="../../../../../com/ibm/wps/portlets/struts/ViewCommandExecutionContext.html" title="class in com.ibm.wps.portlets.struts">ViewCommandExecutionContext</A>&nbsp;context)
                                    throws <A HREF="../../../../../org/apache/jetspeed/portlet/PortletException.html" title="class in org.apache.jetspeed.portlet">PortletException</A></PRE>
<DL>
<DD>Gets the saved command from the Command Manager Factory.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>context</CODE> - the view command execution context
<DT><B>Returns:</B><DD>returns the saved IViewCommand command
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../org/apache/jetspeed/portlet/PortletException.html" title="class in org.apache.jetspeed.portlet">PortletException</A></CODE> - if the request cannot fulfilled</DL>
</DD>
</DL>
<HR>

<A NAME="saveCommand(javax.servlet.http.HttpServletRequest)"><!-- --></A><H3>
saveCommand</H3>
<PRE>
public void <B>saveCommand</B>(javax.servlet.http.HttpServletRequest&nbsp;request)
                 throws <A HREF="../../../../../org/apache/jetspeed/portlet/PortletException.html" title="class in org.apache.jetspeed.portlet">PortletException</A></PRE>
<DL>
<DD>Saves the current command using the Command Manager Factory.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>request</CODE> - The request object
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../org/apache/jetspeed/portlet/PortletException.html" title="class in org.apache.jetspeed.portlet">PortletException</A></CODE></DL>
</DD>
</DL>
<HR>

<A NAME="saveCommand(javax.servlet.http.HttpServletRequest, java.lang.String)"><!-- --></A><H3>
saveCommand</H3>
<PRE>
public void <B>saveCommand</B>(javax.servlet.http.HttpServletRequest&nbsp;request,
                        java.lang.String&nbsp;commandPrefix)
                 throws <A HREF="../../../../../org/apache/jetspeed/portlet/PortletException.html" title="class in org.apache.jetspeed.portlet">PortletException</A></PRE>
<DL>
<DD>Saves the current command using the Command Manager Factory.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>request</CODE> - The request object<DD><CODE>commandPrefix</CODE> - the prefix to store the command
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../org/apache/jetspeed/portlet/PortletException.html" title="class in org.apache.jetspeed.portlet">PortletException</A></CODE> - if the request cannot fulfilled</DL>
</DD>
</DL>
<HR>

<A NAME="repopulateRequest(org.apache.jetspeed.portlet.PortletRequest)"><!-- --></A><H3>
repopulateRequest</H3>
<PRE>
protected void <B>repopulateRequest</B>(<A HREF="../../../../../org/apache/jetspeed/portlet/PortletRequest.html" title="interface in org.apache.jetspeed.portlet">PortletRequest</A>&nbsp;request)</PRE>
<DL>
<DD>Repopulates the given request from saved values. The request attributes
 that were saved as part of the saveAttributes call are repopulated in the
 render phase of portal. This method should only be called from this
 class's execute method.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>request</CODE> - The request object to repopulate</DL>
</DD>
</DL>
<HR>

<A NAME="execute(org.apache.jetspeed.portlet.PortletRequest, org.apache.jetspeed.portlet.PortletResponse, com.ibm.wps.portlets.struts.ViewCommandExecutionContext)"><!-- --></A><H3>
execute</H3>
<PRE>
public void <B>execute</B>(<A HREF="../../../../../org/apache/jetspeed/portlet/PortletRequest.html" title="interface in org.apache.jetspeed.portlet">PortletRequest</A>&nbsp;request,
                    <A HREF="../../../../../org/apache/jetspeed/portlet/PortletResponse.html" title="interface in org.apache.jetspeed.portlet">PortletResponse</A>&nbsp;response,
                    <A HREF="../../../../../com/ibm/wps/portlets/struts/ViewCommandExecutionContext.html" title="class in com.ibm.wps.portlets.struts">ViewCommandExecutionContext</A>&nbsp;executionContext)
             throws <A HREF="../../../../../org/apache/jetspeed/portlet/PortletException.html" title="class in org.apache.jetspeed.portlet">PortletException</A></PRE>
<DL>
<DD>Executes the given command given the request and response objects. This
 base implementation must be called by all subclasses. The request attributes
 are repopulated and the Struts module is selected.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../com/ibm/wps/portlets/struts/IViewCommand.html#execute(org.apache.jetspeed.portlet.PortletRequest, org.apache.jetspeed.portlet.PortletResponse, com.ibm.wps.portlets.struts.ViewCommandExecutionContext)">execute</A></CODE> in interface <CODE><A HREF="../../../../../com/ibm/wps/portlets/struts/IViewCommand.html" title="interface in com.ibm.wps.portlets.struts">IViewCommand</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>request</CODE> - The request object<DD><CODE>executionContext</CODE> - the execution context object<DD><CODE>response</CODE> - The response object
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../org/apache/jetspeed/portlet/PortletException.html" title="class in org.apache.jetspeed.portlet">PortletException</A></CODE> - if the request cannot fulfilled</DL>
</DD>
</DL>
<HR>

<A NAME="saveAttributes(javax.servlet.http.HttpServletRequest, com.ibm.wps.portlets.struts.ViewCommandExecutionContext, java.util.List, java.util.List)"><!-- --></A><H3>
saveAttributes</H3>
<PRE>
protected void <B>saveAttributes</B>(javax.servlet.http.HttpServletRequest&nbsp;request,
                              <A HREF="../../../../../com/ibm/wps/portlets/struts/ViewCommandExecutionContext.html" title="class in com.ibm.wps.portlets.struts">ViewCommandExecutionContext</A>&nbsp;context,
                              java.util.List&nbsp;namesToSave,
                              java.util.List&nbsp;typesToSave)</PRE>
<DL>
<DD>Saves attributes from the request by name for later retrieval
 when the command is executed. This method is used by subclasses
 that maintain their own list of attribute names and types to save.
 This convenience method saves the attributes so that they can 
 be retrieved by the call to repopulateRequest.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>request</CODE> - The request object to save attributes from<DD><CODE>context</CODE> - the view command execution context<DD><CODE>namesToSave</CODE> - a list of the attribute names to save<DD><CODE>typesToSave</CODE> - a list of the types to save</DL>
</DD>
</DL>
<HR>

<A NAME="saveAttribute(javax.servlet.http.HttpServletRequest, java.lang.String)"><!-- --></A><H3>
saveAttribute</H3>
<PRE>
protected void <B>saveAttribute</B>(javax.servlet.http.HttpServletRequest&nbsp;request,
                             java.lang.String&nbsp;name)</PRE>
<DL>
<DD>Saves the given request attribute for later retrieval when the command is
 executed.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>request</CODE> - The request object to get attribute from<DD><CODE>name</CODE> - of attribute to save</DL>
</DD>
</DL>
<HR>

<A NAME="saveAsAttribute(java.lang.String, java.lang.Object)"><!-- --></A><H3>
saveAsAttribute</H3>
<PRE>
protected void <B>saveAsAttribute</B>(java.lang.String&nbsp;name,
                               java.lang.Object&nbsp;value)</PRE>
<DL>
<DD>Saves the given named object for later retrieval as an attribute
 for when the command is executed.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - of attribute to save<DD><CODE>value</CODE> - the value to store</DL>
</DD>
</DL>
<HR>

<A NAME="saveParameters(javax.servlet.http.HttpServletRequest, com.ibm.wps.portlets.struts.ViewCommandExecutionContext, java.util.List)"><!-- --></A><H3>
saveParameters</H3>
<PRE>
protected void <B>saveParameters</B>(javax.servlet.http.HttpServletRequest&nbsp;request,
                              <A HREF="../../../../../com/ibm/wps/portlets/struts/ViewCommandExecutionContext.html" title="class in com.ibm.wps.portlets.struts">ViewCommandExecutionContext</A>&nbsp;context,
                              java.util.List&nbsp;namesToSave)</PRE>
<DL>
<DD>Saves parameters from the request by name for later retrieval
 when the command is executed. This method is used by subclasses
 that maintain their own list of parameters names to save.
 This convenience method saves the parameters so that they can 
 be retrieved by the call to repopulateRequest.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>request</CODE> - The request object to save parameters from<DD><CODE>context</CODE> - the view command execution context<DD><CODE>namesToSave</CODE> - a list of the attribute names to save</DL>
</DD>
</DL>
<HR>

<A NAME="saveParameter(javax.servlet.http.HttpServletRequest, java.lang.String)"><!-- --></A><H3>
saveParameter</H3>
<PRE>
protected void <B>saveParameter</B>(javax.servlet.http.HttpServletRequest&nbsp;request,
                             java.lang.String&nbsp;name)</PRE>
<DL>
<DD>Saves the given request parameter for later retrieval when the command is
 executed.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>request</CODE> - The request object to get parameter from<DD><CODE>name</CODE> - of parameter to save</DL>
</DD>
</DL>
<HR>

<A NAME="saveAsParameter(java.lang.String, java.lang.String)"><!-- --></A><H3>
saveAsParameter</H3>
<PRE>
protected void <B>saveAsParameter</B>(java.lang.String&nbsp;name,
                               java.lang.String&nbsp;value)</PRE>
<DL>
<DD>Saves the given named object for later retrieval as an parameter
 for when the command is executed.
<P>