contentreference.html

门户开发

 This flag cannot be set. If you want to store content in the <A HREF="../../../../../com/ibm/content/binder/model/Binder.html" title="interface in com.ibm.content.binder.model"><CODE>Binder</CODE></A> rather
 than reference content stored in a content provider, use a
 <A HREF="../../../../../com/ibm/content/binder/model/ContentItem.html" title="interface in com.ibm.content.binder.model"><CODE>ContentItem</CODE></A> instead of a <code>ContentReference</code>.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>true if the content is stored in the <A HREF="../../../../../com/ibm/content/binder/model/Binder.html" title="interface in com.ibm.content.binder.model"><CODE>Binder</CODE></A>, false if it is
          referenced.</DL>
</DD>
</DL>
<HR>

<A NAME="isReference()"><!-- --></A><H3>
isReference</H3>
<PRE>
public boolean <B>isReference</B>()</PRE>
<DL>
<DD>Flag indicating if the content represented by this
 <code>ContentReference</code> is stored in the <A HREF="../../../../../com/ibm/content/binder/model/Binder.html" title="interface in com.ibm.content.binder.model"><CODE>Binder</CODE></A>, or in an
 external content provider. <br><br>
 
 This flag cannot be set. If you want to store content in the <A HREF="../../../../../com/ibm/content/binder/model/Binder.html" title="interface in com.ibm.content.binder.model"><CODE>Binder</CODE></A> rather
 than reference content stored in a content provider, use a
 <A HREF="../../../../../com/ibm/content/binder/model/ContentItem.html" title="interface in com.ibm.content.binder.model"><CODE>ContentItem</CODE></A> instead of a <code>ContentReference</code>.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>true if the content is referenced (stored in a content provider
          rather than in the <A HREF="../../../../../com/ibm/content/binder/model/Binder.html" title="interface in com.ibm.content.binder.model"><CODE>Binder</CODE></A>),
 		false if it is stored inside it.</DL>
</DD>
</DL>
<HR>

<A NAME="getType()"><!-- --></A><H3>
getType</H3>
<PRE>
public java.lang.String <B>getType</B>()</PRE>
<DL>
<DD>The type of the content referenced by this <code>ContentReference</code>.
 <br><br>
 
 The supported types depend on the content provider hosting the referenced
 content. For the PDM content provider, the type is optional.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the type of the referenced content as a String.</DL>
</DD>
</DL>
<HR>

<A NAME="setType(java.lang.String)"><!-- --></A><H3>
setType</H3>
<PRE>
public void <B>setType</B>(java.lang.String&nbsp;type)</PRE>
<DL>
<DD>Set the type of the content referenced by this <code>ContentReference</code>.
 <br><br>

 The supported types depend on the content provider hosting the referenced
 content. For the PDM content provider, the type is optional.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>type</CODE> - the type of the referenced content.</DL>
</DD>
</DL>
<HR>

<A NAME="getContentProvider()"><!-- --></A><H3>
getContentProvider</H3>
<PRE>
public java.lang.String <B>getContentProvider</B>()</PRE>
<DL>
<DD>A String identifying the <a href="#cp">content provider</a> that hosts the
 content referenced by this <code>ContentReference</code>. <br><br>
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the provider that hosts the referenced content<DT><B>See Also:</B><DD><A HREF="../../../../../com/ibm/content/binder/model/ContentReference.html#CONTENT_PROVIDER_PDM"><CODE>CONTENT_PROVIDER_PDM</CODE></A>, 
<A HREF="../../../../../com/ibm/content/binder/model/ContentReference.html#CONTENT_PROVIDER_SIMPLE_VALUE"><CODE>CONTENT_PROVIDER_SIMPLE_VALUE</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="setContentProvider(java.lang.String)"><!-- --></A><H3>
setContentProvider</H3>
<PRE>
public void <B>setContentProvider</B>(java.lang.String&nbsp;contentProvider)</PRE>
<DL>
<DD>Sets the <a href="#cp">content provider</a> that hosts the content
 referenced by this <code>ContentReference</code>. <br><br>
 
 The constants <A HREF="../../../../../com/ibm/content/binder/model/ContentReference.html#CONTENT_PROVIDER_PDM"><CODE>CONTENT_PROVIDER_PDM</CODE></A> and
 <A HREF="../../../../../com/ibm/content/binder/model/ContentReference.html#CONTENT_PROVIDER_SIMPLE_VALUE"><CODE>CONTENT_PROVIDER_SIMPLE_VALUE</CODE></A> can be used.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>contentProvider</CODE> - the provider that hosts the referenced content<DT><B>See Also:</B><DD><A HREF="../../../../../com/ibm/content/binder/model/ContentReference.html#CONTENT_PROVIDER_PDM"><CODE>CONTENT_PROVIDER_PDM</CODE></A>, 
<A HREF="../../../../../com/ibm/content/binder/model/ContentReference.html#CONTENT_PROVIDER_SIMPLE_VALUE"><CODE>CONTENT_PROVIDER_SIMPLE_VALUE</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="getUri()"><!-- --></A><H3>
getUri</H3>
<PRE>
public java.lang.String <B>getUri</B>()</PRE>
<DL>
<DD>The URI of the referenced content. <br><br>
 
 The format of this URI depends on the content provider that is hosting the
 referenced content:<br>For the <b>PDM</b> content provide, the URI should
 be the path of the document to reference in the document library.<br>For
 the <b>simple value</b> content provider, the URI is the value itself, and
 therefore can be any String.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the URI of the reference content</DL>
</DD>
</DL>
<HR>

<A NAME="setUri(java.lang.String)"><!-- --></A><H3>
setUri</H3>
<PRE>
public void <B>setUri</B>(java.lang.String&nbsp;uri)</PRE>
<DL>
<DD>Sets the URI of the referenced content. <br><br>
 
 The format of this URI depends on the content provider that is hosting the
 referenced content:<br>For the <b>PDM</b> content provide, the URI should
 be the path of the document to reference in the document library.<br>For
 the <b>simple value</b> content provider, the URI is the value itself, and
 therefore can be any String.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>uri</CODE> - the URI to the referenced content</DL>
</DD>
</DL>
<HR>

<A NAME="isVisible()"><!-- --></A><H3>
isVisible</H3>
<PRE>
public boolean <B>isVisible</B>()</PRE>
<DL>
<DD>Flag indicating if this reference should be displayed in a user interface.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>true if this reference should be made visible, false otherwise.</DL>
</DD>
</DL>
<HR>

<A NAME="setVisible(boolean)"><!-- --></A><H3>
setVisible</H3>
<PRE>
public void <B>setVisible</B>(boolean&nbsp;isVisible)</PRE>
<DL>
<DD>Sets the flag indicating if this reference should be displayed in a user
 interface.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>isVisible</CODE> - true if this reference should be made visible, false
 otherwise.</DL>
</DD>
</DL>
<HR>

<A NAME="getMetadata(java.lang.String)"><!-- --></A><H3>
getMetadata</H3>
<PRE>
public java.lang.Object <B>getMetadata</B>(java.lang.String&nbsp;metadataName)</PRE>
<DL>
<DD>Returns a metadata attribute associated with the content referenced by
 this <code>ContentReference</code>. The list of available metadata
 attributes is listed in the <A HREF="../../../../../com/ibm/content/binder/model/Metadata.html" title="interface in com.ibm.content.binder.model"><CODE>Metadata</CODE></A> interface.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>metadataName</CODE> - the name of the metadata attribute to return. See <A HREF="../../../../../com/ibm/content/binder/model/Metadata.html" title="interface in com.ibm.content.binder.model"><CODE>Metadata</CODE></A>.
<DT><B>Returns:</B><DD>the metadata value as an Object.</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/content/binder/model/ContentItem.html" title="interface in com.ibm.content.binder.model"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../../com/ibm/content/binder/model/Metadata.html" title="interface in com.ibm.content.binder.model"><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="ContentReference.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>