wpsstrutsportletmessage.html

门户开发

<TD COLSPAN=1><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TD>
</TR>
</TABLE>

<A NAME="WpsStrutsPortletMessage()"><!-- --></A><H3>
WpsStrutsPortletMessage</H3>
<PRE>
public <B>WpsStrutsPortletMessage</B>()</PRE>
<DL>
<DD>Constructor for the WpsStrutsPortletMessage class.
<P>
</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="setAttribute(java.lang.Object)"><!-- --></A><H3>
setAttribute</H3>
<PRE>
public void <B>setAttribute</B>(java.lang.Object&nbsp;attribute)</PRE>
<DL>
<DD>Sets an attribute that can be passed to the WpsStrutsPortlet. This attribute can 
 be obtained in a Struts action by get the WpsStrutsConstants.SPF_MESSAGE_ATTRIBUTE
 from the request object.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../com/ibm/wps/portlets/struts/IStrutsPortletMessage.html#setAttribute(java.lang.Object)">setAttribute</A></CODE> in interface <CODE><A HREF="../../../../../com/ibm/wps/portlets/struts/IStrutsPortletMessage.html" title="interface in com.ibm.wps.portlets.struts">IStrutsPortletMessage</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>attribute</CODE> - the attribute value</DL>
</DD>
</DL>
<HR>

<A NAME="getAttribute()"><!-- --></A><H3>
getAttribute</H3>
<PRE>
public java.lang.Object <B>getAttribute</B>()</PRE>
<DL>
<DD>Returns the object set in the portlet message.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../com/ibm/wps/portlets/struts/IStrutsPortletMessage.html#getAttribute()">getAttribute</A></CODE> in interface <CODE><A HREF="../../../../../com/ibm/wps/portlets/struts/IStrutsPortletMessage.html" title="interface in com.ibm.wps.portlets.struts">IStrutsPortletMessage</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>returns the attribute, can be <code>null</code></DL>
</DD>
</DL>
<HR>

<A NAME="setConcretePortletName(java.lang.String)"><!-- --></A><H3>
setConcretePortletName</H3>
<PRE>
public void <B>setConcretePortletName</B>(java.lang.String&nbsp;name)</PRE>
<DL>
<DD>Allows specifying the concrete portlet name for an additional level of filtering. 
 The PortletContext send is based on the name of the abstract portlet. 
 If the concrete portlet name is specified then only that portlet will 
 see this message.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../com/ibm/wps/portlets/struts/IStrutsPortletMessage.html#setConcretePortletName(java.lang.String)">setConcretePortletName</A></CODE> in interface <CODE><A HREF="../../../../../com/ibm/wps/portlets/struts/IStrutsPortletMessage.html" title="interface in com.ibm.wps.portlets.struts">IStrutsPortletMessage</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the concrete portlet name</DL>
</DD>
</DL>
<HR>

<A NAME="getConcretePortletName()"><!-- --></A><H3>
getConcretePortletName</H3>
<PRE>
public java.lang.String <B>getConcretePortletName</B>()</PRE>
<DL>
<DD>Returns the set name of the concrete portlet.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../com/ibm/wps/portlets/struts/IStrutsPortletMessage.html#getConcretePortletName()">getConcretePortletName</A></CODE> in interface <CODE><A HREF="../../../../../com/ibm/wps/portlets/struts/IStrutsPortletMessage.html" title="interface in com.ibm.wps.portlets.struts">IStrutsPortletMessage</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>returns concrete portlet name, can be <code>null</code></DL>
</DD>
</DL>
<HR>

<A NAME="setStrutsAction(java.lang.String)"><!-- --></A><H3>
setStrutsAction</H3>
<PRE>
public void <B>setStrutsAction</B>(java.lang.String&nbsp;action)</PRE>
<DL>
<DD>Allows specifying the name of the action that will be executed. The action is assumed to be
 context-relative.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../com/ibm/wps/portlets/struts/IStrutsPortletMessage.html#setStrutsAction(java.lang.String)">setStrutsAction</A></CODE> in interface <CODE><A HREF="../../../../../com/ibm/wps/portlets/struts/IStrutsPortletMessage.html" title="interface in com.ibm.wps.portlets.struts">IStrutsPortletMessage</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>action</CODE> - the Struts action</DL>
</DD>
</DL>
<HR>

<A NAME="getStrutsAction()"><!-- --></A><H3>
getStrutsAction</H3>
<PRE>
public java.lang.String <B>getStrutsAction</B>()</PRE>
<DL>
<DD>Returns the Struts action.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../com/ibm/wps/portlets/struts/IStrutsPortletMessage.html#getStrutsAction()">getStrutsAction</A></CODE> in interface <CODE><A HREF="../../../../../com/ibm/wps/portlets/struts/IStrutsPortletMessage.html" title="interface in com.ibm.wps.portlets.struts">IStrutsPortletMessage</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>returns the Struts action, can be <code>null</code></DL>
</DD>
</DL>
<HR>

<A NAME="setStrutsForward(java.lang.String)"><!-- --></A><H3>
setStrutsForward</H3>
<PRE>
public void <B>setStrutsForward</B>(java.lang.String&nbsp;forward)</PRE>
<DL>
<DD>Allows specifying the name of a Struts forward that will be executed. The forward is assumed to be
 contextRelative. If the Struts forward and the Struts action are both set then only the action is 
 executed.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../com/ibm/wps/portlets/struts/IStrutsPortletMessage.html#setStrutsForward(java.lang.String)">setStrutsForward</A></CODE> in interface <CODE><A HREF="../../../../../com/ibm/wps/portlets/struts/IStrutsPortletMessage.html" title="interface in com.ibm.wps.portlets.struts">IStrutsPortletMessage</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>forward</CODE> - the Struts forward</DL>
</DD>
</DL>
<HR>

<A NAME="getStrutsForward()"><!-- --></A><H3>
getStrutsForward</H3>
<PRE>
public java.lang.String <B>getStrutsForward</B>()</PRE>
<DL>
<DD>Returns the Struts forward.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../com/ibm/wps/portlets/struts/IStrutsPortletMessage.html#getStrutsForward()">getStrutsForward</A></CODE> in interface <CODE><A HREF="../../../../../com/ibm/wps/portlets/struts/IStrutsPortletMessage.html" title="interface in com.ibm.wps.portlets.struts">IStrutsPortletMessage</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>returns the Struts forward, can be <code>null</code></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/wps/portlets/struts/WpsStrutsPortlet.html" title="class in com.ibm.wps.portlets.struts"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../../com/ibm/wps/portlets/struts/WpsStrutsViewActionCommand.html" title="class in com.ibm.wps.portlets.struts"><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="WpsStrutsPortletMessage.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;FIELD&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;FIELD&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>