📄 parameter.html
字号:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"><!--NewPage--><HTML><HEAD><!-- Generated by javadoc (build 1.4.2) on Wed Jul 19 18:22:42 EDT 2006 --><TITLE>Parameter (IBM WebSphere Portal Version 6.0.0.0 API Docs)</TITLE><META NAME="keywords" CONTENT="com.ibm.wps.pb.property.Parameter interface"><LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style"><SCRIPT type="text/javascript">function windowTitle(){ parent.document.title="Parameter (IBM WebSphere Portal Version 6.0.0.0 API Docs)";}</SCRIPT></HEAD><BODY BGCOLOR="white" onload="windowTitle();"><!-- ========= START OF TOP NAVBAR ======= --><A NAME="navbar_top"><!-- --></A><A HREF="#skip-navbar_top" 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_top_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> </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"> <A HREF="#main"><FONT CLASS="NavBarFont1Rev"><B>Class</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="../../../../../serialized-form.html"><FONT CLASS="NavBarFont1"><B>Serialized</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"> <A HREF="../../../../../com/ibm/wps/pb/property/ActionTriggerMarkup.html" title="interface in com.ibm.wps.pb.property"><B>PREV CLASS</B></A> <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> <A HREF="Parameter.html" target="_top"><B>NO FRAMES</B></A> <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: NESTED | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD><TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD></TR></TABLE><A NAME="skip-navbar_top"></A><!-- ========= END OF TOP NAVBAR ========= --><HR><A NAME="main"></A><!-- ======== START OF CLASS DATA ======== --><H2><FONT SIZE="-1">com.ibm.wps.pb.property</FONT><BR>Interface Parameter</H2><HR><DL><DT>public interface <B>Parameter</B></DL><P>For use by portlets written to the IBM portlet API. <p> An action (encapsulated in the <code>Action</code> interface) is associated with several parameters (encapsulated in the <code>Parameter</code> interface), and each parameter is associated with a property (encapsulated in the <code>Property</code> interface). This interface is used to provide additional information about how a property is to be passed to/from the specific action it is associated with. If actions are declared in a WSDL file, the runtime will construct and register the <code>Action</code> and associated <code>Parameter</code> objects. If a WSDL file is not used, parameters may be programmatically constructed using <code>PropertyFactory</code>, followed by invoking the setters.<P><P><DL><DT><B>Since:</B></DT> <DD>5.0</DD><DT><B>See Also:</B><DD><A HREF="../../../../../com/ibm/wps/pb/property/PropertyFactory.html" title="class in com.ibm.wps.pb.property"><CODE>PropertyFactory</CODE></A>, <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/Property.html" title="interface in com.ibm.wps.pb.property"><CODE>Property</CODE></A></DL><HR><P><!-- ======== NESTED CLASS SUMMARY ======== --><!-- =========== FIELD SUMMARY =========== --><A NAME="field_summary"><!-- --></A><TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""><TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"><TH ALIGN="left" COLSPAN=2><FONT SIZE="+2"><B>Field Summary</B></FONT></TH></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE>static java.lang.String</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../com/ibm/wps/pb/property/Parameter.html#BOUND_TO_ACTION">BOUND_TO_ACTION</A></B></CODE><BR> Specifies that the parameter value is bound as an action parameter when the action is invoked.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE>static java.lang.String</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../com/ibm/wps/pb/property/Parameter.html#BOUND_TO_REQUEST_ATTRIBUTE">BOUND_TO_REQUEST_ATTRIBUTE</A></B></CODE><BR> Specifies that the parameter value is bound as a request attribute when the action is invoked.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE>static java.lang.String</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../com/ibm/wps/pb/property/Parameter.html#BOUND_TO_REQUEST_PARAMETER">BOUND_TO_REQUEST_PARAMETER</A></B></CODE><BR> Specifies that the parameter value is bound as a request parameter when the action is invoked.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE>static java.lang.String</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../com/ibm/wps/pb/property/Parameter.html#BOUND_TO_SESSION">BOUND_TO_SESSION</A></B></CODE><BR> Specifies that the parameter value is bound as a session attribute when the action is invoked.</TD></TR></TABLE> <!-- ======== CONSTRUCTOR SUMMARY ======== --><!-- ========== METHOD SUMMARY =========== --><A NAME="method_summary"><!-- --></A><TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""><TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"><TH ALIGN="left" COLSPAN=2><FONT SIZE="+2"><B>Method Summary</B></FONT></TH></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> <A HREF="../../../../../com/ibm/wps/pb/property/Action.html" title="interface in com.ibm.wps.pb.property">Action</A></CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../com/ibm/wps/pb/property/Parameter.html#getAction()">getAction</A></B>()</CODE><BR> Returns the parent <code>Action</code> object.</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="../../../../../com/ibm/wps/pb/property/Parameter.html#getBoundTo()">getBoundTo</A></B>()</CODE><BR> Returns where the parameter is bound.</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="../../../../../com/ibm/wps/pb/property/Parameter.html#getDescription()">getDescription</A></B>()</CODE><BR> <B>Deprecated.</B> <I></I> </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="../../../../../com/ibm/wps/pb/property/Parameter.html#getDescription(java.util.Locale)">getDescription</A></B>(java.util.Locale locale)</CODE><BR> Return a string containing a description of the parameter.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> <A HREF="../../../../../com/ibm/wps/pb/property/Property.html" title="interface in com.ibm.wps.pb.property">Property</A></CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../com/ibm/wps/pb/property/Parameter.html#getProperty()">getProperty</A></B>()</CODE><BR> Returns the associated <code>Property</code> object.</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="../../../../../com/ibm/wps/pb/property/Parameter.html#getTitle()">getTitle</A></B>()</CODE><BR> <B>Deprecated.</B> <I></I> </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="../../../../../com/ibm/wps/pb/property/Parameter.html#getTitle(java.util.Locale)">getTitle</A></B>(java.util.Locale locale)</CODE><BR> Returns a string containing a short description of the parameter.</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="../../../../../com/ibm/wps/pb/property/Parameter.html#isPresentIfNullValue()">isPresentIfNullValue</A></B>()</CODE><BR> Returns a value that governs the wire-triggering behavior if a parameter is found, but its value is null.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> void</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../com/ibm/wps/pb/property/Parameter.html#setBoundTo(java.lang.String)">setBoundTo</A></B>(java.lang.String boundTo)</CODE><BR> Set where the parameter is bound.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> void</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../com/ibm/wps/pb/property/Parameter.html#setDescription(java.lang.String)">setDescription</A></B>(java.lang.String descriptionKey)</CODE><BR> <B>Deprecated.</B> <I></I> </TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> void</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../com/ibm/wps/pb/property/Parameter.html#setDescriptionKey(java.lang.String)">setDescriptionKey</A></B>(java.lang.String descriptionKey)</CODE><BR> Set the key for the description.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> void</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../com/ibm/wps/pb/property/Parameter.html#setPresentIfNullValue(boolean)">setPresentIfNullValue</A></B>(boolean presentIfNullValue)</CODE><BR> Setter for presentIfNullValue.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> void</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../com/ibm/wps/pb/property/Parameter.html#setTitle(java.lang.String)">setTitle</A></B>(java.lang.String titleKey)</CODE><BR> <B>Deprecated.</B> <I></I> </TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> void</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../com/ibm/wps/pb/property/Parameter.html#setTitleKey(java.lang.String)">setTitleKey</A></B>(java.lang.String titleKey)</CODE><BR> Set the key for the title.</TD></TR></TABLE> <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="BOUND_TO_REQUEST_ATTRIBUTE"><!-- --></A><H3>BOUND_TO_REQUEST_ATTRIBUTE</H3><PRE>public static final java.lang.String <B>BOUND_TO_REQUEST_ATTRIBUTE</B></PRE><DL><DD>Specifies that the parameter value is bound as a request 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_REQUEST_ATTRIBUTE">Constant Field Values</A></DL></DL><HR><A NAME="BOUND_TO_REQUEST_PARAMETER"><!-- --></A><H3>BOUND_TO_REQUEST_PARAMETER</H3><PRE>public static final java.lang.String <B>BOUND_TO_REQUEST_PARAMETER</B></PRE><DL><DD>Specifies that the parameter value is bound as a request parameter 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_REQUEST_PARAMETER">Constant Field Values</A></DL></DL><HR>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -