property.html

门户开发

</TR>
</TABLE>

<A NAME="getName()"><!-- --></A><H3>
getName</H3>
<PRE>
public java.lang.String <B>getName</B>()</PRE>
<DL>
<DD>Returns the name of the property.
 Property names must be unique within the set associated with a component definition. 
 The name is a required field (i.e.
 must not be null).
<P>
<DD><DL>

<DT><B>Returns:</B><DD>a <code>String</code> containing the name of the property.</DL>
</DD>
</DL>
<HR>

<A NAME="getId()"><!-- --></A><H3>
getId</H3>
<PRE>
public java.lang.Object <B>getId</B>()</PRE>
<DL>
<DD>Returns a globally unique id identifying the property.
 This cannot be set through <code>PropertyController</code> but
 will be set by the runtime once the property has been created and
 registered. If the <code>Property</code> object has been created
 but not registered, this method will return null.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>an <code>Object</code> which serves as the globally unique 
 identifier for the property.</DL>
</DD>
</DL>
<HR>

<A NAME="getType()"><!-- --></A><H3>
getType</H3>
<PRE>
public java.lang.String <B>getType</B>()</PRE>
<DL>
<DD>Returns a string containing the property type. 
 The type is associated with the semantics of the property
 e.g. PhoneNo, orderID etc. This field is required.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>a <code>String</code> containing the property type.</DL>
</DD>
</DL>
<HR>

<A NAME="getNamespace()"><!-- --></A><H3>
getNamespace</H3>
<PRE>
public java.lang.String <B>getNamespace</B>()</PRE>
<DL>
<DD>Returns a string containing the type namespace.
 A namespace may be used to group related types in a domain of types, to prevent
 collisions with similarly named types created in a different domain. 
 This is optional; if omitted, no namespace is used. No namespace is indicated by the empty string. 
 If specified, it will
 be used in conjunction with type to restrict matches.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>a <code>String</code> containing the type namespace.<DT><B>See Also:</B><DD><A HREF="../../../../../com/ibm/portal/propertybroker/property/Property.html#getType()"><CODE>getType()</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="getSchemaLocation()"><!-- --></A><H3>
getSchemaLocation</H3>
<PRE>
public java.lang.String <B>getSchemaLocation</B>()</PRE>
<DL>
<DD>Return a string containing the absolute URL or relative path to a
 document containing the type schema. This is optional. If not specified, an
 empty string will be returned. If specified, it may be used for validation of the property value.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>a <code>String</code> containing the absolute URL or relative path to a schema.</DL>
</DD>
</DL>
<HR>

<A NAME="getDirection()"><!-- --></A><H3>
getDirection</H3>
<PRE>
public <A HREF="../../../../../com/ibm/portal/propertybroker/property/Direction.html" title="class in com.ibm.portal.propertybroker.property">Direction</A> <B>getDirection</B>()</PRE>
<DL>
<DD>Returns whether the property is produced or consumed.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>a <code>Direction</code> object indicating the direction<DT><B>See Also:</B><DD><A HREF="../../../../../com/ibm/portal/propertybroker/property/Direction.html" title="class in com.ibm.portal.propertybroker.property"><CODE>Direction</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 short description for this property for the provided locale.
 Suitable for display by tools or as help text.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>locale</CODE> - the current locale
<DT><B>Returns:</B><DD>a short description for this property for the provided locale.</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>Returns a text description for this property for the provided locale.
 Suitable for display by tools or as help text.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>locale</CODE> - the current locale
<DT><B>Returns:</B><DD>a text description for this property for the provided locale.</DL>
</DD>
</DL>
<HR>

<A NAME="getClassname()"><!-- --></A><H3>
getClassname</H3>
<PRE>
public java.lang.String <B>getClassname</B>()</PRE>
<DL>
<DD>Returns class used to encapsulate the property value.
 The default is <code>String</code>.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>a <code>String</code> containing the class name of the value of the property.</DL>
</DD>
</DL>
<HR>

<A NAME="getClassName()"><!-- --></A><H3>
getClassName</H3>
<PRE>
public java.lang.String <B>getClassName</B>()</PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<I>Use <code>getClassname</code> instead.</I>
<P>
<DD><DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../com/ibm/portal/propertybroker/property/Property.html#getClassname()"><CODE>getClassname()</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="getOwningDefinitionId()"><!-- --></A><H3>
getOwningDefinitionId</H3>
<PRE>
public java.lang.Object <B>getOwningDefinitionId</B>()</PRE>
<DL>
<DD>Return the id of the owning component this property is associated with. In a
 Websphere Portal environment this would be the portlet definition id.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the owning component id object this property is associated with.</DL>
</DD>
</DL>
<HR>

<A NAME="getSupportedLocales()"><!-- --></A><H3>
getSupportedLocales</H3>
<PRE>
public java.util.Locale[] <B>getSupportedLocales</B>()</PRE>
<DL>
<DD>Returns the supported locales for the displayable text associated
 with the property, such as its title and description.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the array of Locales</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/propertybroker/property/ParameterController.html" title="interface in com.ibm.portal.propertybroker.property"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../../com/ibm/portal/propertybroker/property/PropertyController.html" title="interface in com.ibm.portal.propertybroker.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="Property.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;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&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>