parameter.html

门户开发

<A NAME="BOUND_TO_SESSION"><!-- --></A><H3>
BOUND_TO_SESSION</H3>
<PRE>
public static final java.lang.String <B>BOUND_TO_SESSION</B></PRE>
<DL>
<DD>Specifies that the parameter value is bound as a session attribute
 when the action is invoked.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.ibm.wps.pb.property.Parameter.BOUND_TO_SESSION">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="BOUND_TO_ACTION"><!-- --></A><H3>
BOUND_TO_ACTION</H3>
<PRE>
public static final java.lang.String <B>BOUND_TO_ACTION</B></PRE>
<DL>
<DD>Specifies that the parameter value is bound as an action parameter 
 when the action is invoked. This value may only be specified when the action type
 is <code>DEFAULT_PORTLET_ACTION</code>.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../com/ibm/wps/pb/property/Action.html" title="interface in com.ibm.wps.pb.property"><CODE>Action</CODE></A>, 
<A HREF="../../../../../constant-values.html#com.ibm.wps.pb.property.Parameter.BOUND_TO_ACTION">Constant Field Values</A></DL>
</DL>

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


<!-- ============ 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="getProperty()"><!-- --></A><H3>
getProperty</H3>
<PRE>
public <A HREF="../../../../../com/ibm/wps/pb/property/Property.html" title="interface in com.ibm.wps.pb.property">Property</A> <B>getProperty</B>()</PRE>
<DL>
<DD>Returns the associated <code>Property</code> object.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the associated <code>Property</code> object<DT><B>See Also:</B><DD><A HREF="../../../../../com/ibm/wps/pb/property/Property.html" title="interface in com.ibm.wps.pb.property"><CODE>Property</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="getAction()"><!-- --></A><H3>
getAction</H3>
<PRE>
public <A HREF="../../../../../com/ibm/wps/pb/property/Action.html" title="interface in com.ibm.wps.pb.property">Action</A> <B>getAction</B>()</PRE>
<DL>
<DD>Returns the parent <code>Action</code> object.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the parent <code>Action</code> object<DT><B>See Also:</B><DD><A HREF="../../../../../com/ibm/wps/pb/property/Action.html" title="interface in com.ibm.wps.pb.property"><CODE>Action</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="getBoundTo()"><!-- --></A><H3>
getBoundTo</H3>
<PRE>
public java.lang.String <B>getBoundTo</B>()</PRE>
<DL>
<DD>Returns where the parameter is bound.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>A <code>String</code> that specifies where the parameter is bound.
 The allowed values are specified by the constants in this interface.</DL>
</DD>
</DL>
<HR>

<A NAME="isPresentIfNullValue()"><!-- --></A><H3>
isPresentIfNullValue</H3>
<PRE>
public boolean <B>isPresentIfNullValue</B>()</PRE>
<DL>
<DD>Returns a value that governs the wire-triggering behavior if a parameter is found, but its
 value is null. If true, for output parameters,
 wires will be triggered when the parameter is present, even if the parameter
 value is null. For input parameters, a triggered wire will cause the parameter
 value to be set, even if the value is null. The default value is false, ie, null values
 are not used for triggering wires.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the boolean value governing the above behavior<DT><B>Since:</B></DT>
  <DD>5.1</DD>
</DL>
</DD>
</DL>
<HR>

<A NAME="getTitle()"><!-- --></A><H3>
getTitle</H3>
<PRE>
public java.lang.String <B>getTitle</B>()</PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<I></I>&nbsp;
<P>
<DD>This method is deprecated. Use the locale-specific version.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>a <code>String</code> containing a short description of the parameter.<DT><B>See Also:</B><DD><A HREF="../../../../../com/ibm/wps/pb/property/Parameter.html#getTitle(java.util.Locale)"><CODE>getTitle(Locale)</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="getTitle(java.util.Locale)"><!-- --></A><H3>
getTitle</H3>
<PRE>
public java.lang.String <B>getTitle</B>(java.util.Locale&nbsp;locale)</PRE>
<DL>
<DD>Returns a string containing a short description of the parameter. Displayed by tools as an aid
 to the user.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>locale</CODE> - the current locale
<DT><B>Returns:</B><DD>a <code>String</code> containing a short description of the parameter.</DL>
</DD>
</DL>
<HR>

<A NAME="getDescription()"><!-- --></A><H3>
getDescription</H3>
<PRE>
public java.lang.String <B>getDescription</B>()</PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<I></I>&nbsp;
<P>
<DD>This method is deprecated. Use the locale-specific version.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>a <code>String</code> containing a description of the parameter.<DT><B>See Also:</B><DD><A HREF="../../../../../com/ibm/wps/pb/property/Parameter.html#getDescription(java.util.Locale)"><CODE>getDescription(Locale)</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="getDescription(java.util.Locale)"><!-- --></A><H3>
getDescription</H3>
<PRE>
public java.lang.String <B>getDescription</B>(java.util.Locale&nbsp;locale)</PRE>
<DL>
<DD>Return a string containing a description of the parameter. Displayed by tools or help text as an aid to the user.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>locale</CODE> - the current locale
<DT><B>Returns:</B><DD>a <code>String</code> containing a description of the parameter.</DL>
</DD>
</DL>
<HR>

<A NAME="setBoundTo(java.lang.String)"><!-- --></A><H3>
setBoundTo</H3>
<PRE>
public void <B>setBoundTo</B>(java.lang.String&nbsp;boundTo)
                throws <A HREF="../../../../../com/ibm/wps/pb/service/InvalidPropertyException.html" title="class in com.ibm.wps.pb.service">InvalidPropertyException</A></PRE>
<DL>
<DD>Set where the parameter is bound.
 Must specify one of the constants defined in this class.
 If not explicitly set, the default value is <code>BOUND_TO_REQUEST_PARAMETER</code>.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>boundTo</CODE> - specifies where the parameter is bound.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../com/ibm/wps/pb/service/InvalidPropertyException.html" title="class in com.ibm.wps.pb.service">InvalidPropertyException</A></CODE> - if the value does not satisfy the required constraint.<DT><B>See Also:</B><DD><A HREF="../../../../../com/ibm/wps/pb/property/Parameter.html#getBoundTo()"><CODE>getBoundTo()</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="setPresentIfNullValue(boolean)"><!-- --></A><H3>
setPresentIfNullValue</H3>
<PRE>
public void <B>setPresentIfNullValue</B>(boolean&nbsp;presentIfNullValue)
                           throws <A HREF="../../../../../com/ibm/wps/pb/service/InvalidPropertyException.html" title="class in com.ibm.wps.pb.service">InvalidPropertyException</A></PRE>
<DL>
<DD>Setter for presentIfNullValue. See <code>isPresentIfNullValue</code> for a description of
 how the value is used.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>presentIfNullValue</CODE> - this indicates if null values are significant for this parameter; ie if they will
 cause wires to be triggered
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../com/ibm/wps/pb/service/InvalidPropertyException.html" title="class in com.ibm.wps.pb.service">InvalidPropertyException</A></CODE> - if this <code>Parameter</code> or its associated <code>Property</code> violates
 any required constraints<DT><B>Since:</B></DT>
  <DD>5.1</DD>
<DT><B>See Also:</B><DD><A HREF="../../../../../com/ibm/wps/pb/property/Parameter.html#isPresentIfNullValue()"><CODE>isPresentIfNullValue()</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="setTitle(java.lang.String)"><!-- --></A><H3>
setTitle</H3>
<PRE>
public void <B>setTitle</B>(java.lang.String&nbsp;titleKey)</PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<I></I>&nbsp;
<P>
<DD>This method is deprecated. Use <code>setTitleKey</code> instead.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>titleKey</CODE> - is used as a key to retrieve the locale-specific title.<DT><B>See Also:</B><DD><A HREF="../../../../../com/ibm/wps/pb/property/Parameter.html#setTitleKey(java.lang.String)"><CODE>setTitleKey(String )</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="setTitleKey(java.lang.String)"><!-- --></A><H3>
setTitleKey</H3>
<PRE>
public void <B>setTitleKey</B>(java.lang.String&nbsp;titleKey)</PRE>
<DL>
<DD>Set the key for the title.
 The locale specific
 information is set by the <code>setLocalizationInfo</code> method of the associated <code>Action</code>.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>titleKey</CODE> - is used as a key to retrieve the locale-specific title.<DT><B>See Also:</B><DD><A HREF="../../../../../com/ibm/wps/pb/property/Action.html" title="interface in com.ibm.wps.pb.property"><CODE>Action</CODE></A>, 
<A HREF="../../../../../com/ibm/wps/pb/property/Parameter.html#getTitle(java.util.Locale)"><CODE>getTitle(Locale)</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="setDescription(java.lang.String)"><!-- --></A><H3>
setDescription</H3>
<PRE>
public void <B>setDescription</B>(java.lang.String&nbsp;descriptionKey)</PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<I></I>&nbsp;
<P>
<DD>This method is deprecated. Use <code>setDescriptionKey</code> instead.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>descriptionKey</CODE> - is used as a key to retrieve the locale-specific description.<DT><B>See Also:</B><DD><A HREF="../../../../../com/ibm/wps/pb/property/Parameter.html#setDescriptionKey(java.lang.String)"><CODE>setDescriptionKey(String )</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="setDescriptionKey(java.lang.String)"><!-- --></A><H3>
setDescriptionKey</H3>
<PRE>
public void <B>setDescriptionKey</B>(java.lang.String&nbsp;descriptionKey)</PRE>
<DL>
<DD>Set the key for the description.
 The locale specific
 information is set by the <code>setLocalizationInfo</code> method of the associated <code>Action</code>.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>descriptionKey</CODE> - is used as a key to retrieve the locale-specific description.<DT><B>See Also:</B><DD><A HREF="../../../../../com/ibm/wps/pb/property/Action.html" title="interface in com.ibm.wps.pb.property"><CODE>Action</CODE></A>, 
<A HREF="../../../../../com/ibm/wps/pb/property/Parameter.html#getDescription(java.util.Locale)"><CODE>getDescription(Locale)</CODE></A></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/pb/property/ActionTriggerMarkup.html" title="interface in com.ibm.wps.pb.property"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../../com/ibm/wps/pb/property/Property.html" title="interface in com.ibm.wps.pb.property"><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="Parameter.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;CONSTR&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;CONSTR&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>