Edit D:\app\Administrator\product\11.2.0\dbhome_1\olap\api\doc\oracle\olapi\metadata\mdm\MdmObject.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.5.0_17) on Wed Aug 12 19:50:24 UTC 2009 --> <TITLE> MdmObject (Oracle OLAP Java API Reference) </TITLE> <META NAME="keywords" CONTENT="oracle.olapi.metadata.mdm.MdmObject class"> <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> <SCRIPT type="text/javascript"> function windowTitle() { parent.document.title="MdmObject (Oracle OLAP Java API Reference)"; } </SCRIPT> <NOSCRIPT> </NOSCRIPT> </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=2 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"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </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="../../../../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> <b>Oracle® OLAP Java API Reference<br>11<i>g</i> Release 2 (11.2)</b><br>E10794-01<br>Beta Draft</EM> </TD> </TR> <TR> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../oracle/olapi/metadata/mdm/MdmNamedBuildProcess.html" title="class in oracle.olapi.metadata.mdm"><B>PREV CLASS</B></A> <A HREF="../../../../oracle/olapi/metadata/mdm/MdmObjectVisitor.html" title="interface in oracle.olapi.metadata.mdm"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../index.html?oracle/olapi/metadata/mdm/MdmObject.html" target="_top"><B>FRAMES</B></A> <A HREF="MdmObject.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 | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> </TR> </TABLE> <A NAME="skip-navbar_top"></A> <!-- ========= END OF TOP NAVBAR ========= --> <HR> <!-- ======== START OF CLASS DATA ======== --> <H2> <FONT SIZE="-1"> oracle.olapi.metadata.mdm</FONT> <BR> Class MdmObject</H2> <PRE> java.lang.Object <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../oracle/olapi/metadata/BaseMetadataObject.html" title="class in oracle.olapi.metadata">oracle.olapi.metadata.BaseMetadataObject</A> <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>oracle.olapi.metadata.mdm.MdmObject</B> </PRE> <DL> <DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../oracle/olapi/metadata/MetadataObject.html" title="interface in oracle.olapi.metadata">MetadataObject</A></DD> </DL> <DL> <DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../oracle/olapi/metadata/mdm/MdmAssignment.html" title="class in oracle.olapi.metadata.mdm">MdmAssignment</A>, <A HREF="../../../../oracle/olapi/metadata/mdm/MdmCustomMember.html" title="class in oracle.olapi.metadata.mdm">MdmCustomMember</A>, <A HREF="../../../../oracle/olapi/metadata/mdm/MdmDimensionality.html" title="class in oracle.olapi.metadata.mdm">MdmDimensionality</A>, <A HREF="../../../../oracle/olapi/metadata/mdm/MdmModel.html" title="class in oracle.olapi.metadata.mdm">MdmModel</A>, <A HREF="../../../../oracle/olapi/metadata/mdm/MdmNamedBuildProcess.html" title="class in oracle.olapi.metadata.mdm">MdmNamedBuildProcess</A>, <A HREF="../../../../oracle/olapi/metadata/mdm/MdmSchema.html" title="class in oracle.olapi.metadata.mdm">MdmSchema</A>, <A HREF="../../../../oracle/olapi/metadata/mdm/MdmSource.html" title="class in oracle.olapi.metadata.mdm">MdmSource</A></DD> </DL> <HR> <DL> <DT><PRE>public abstract class <B>MdmObject</B><DT>extends <A HREF="../../../../oracle/olapi/metadata/BaseMetadataObject.html" title="class in oracle.olapi.metadata">BaseMetadataObject</A></DL> </PRE> <P> An object that describes a particular set of data, such as a measure of product unit prices or a dimension of time values. This class is the basic implementation of the <code>MetadataObject</code> interface. <P> An <code>MdmObject</code> has only the most fundamental properties, so very few specific data characteristics are associated with it. An <code>MdmObject</code> has methods that get or set the following characteristics of the object. <UL> <LI>Name <LI>Descriptions <LI>Classifications </UL> <P> In addition to a name, an <code>MdmObject</code> can have other decriptive words or phrases associated with it, such as a plural name or a short or long description. An <code>MdmObject</code> can also have one or more classifications. Classifications are assigned and handled by an application. <P> <P> <DL> <DT><B>See Also:</B><DD><A HREF="../../../../oracle/olapi/metadata/MetadataObject.html" title="interface in oracle.olapi.metadata"><CODE>MetadataObject</CODE></A></DL> <HR> <P> <!-- ========== 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>abstract java.lang.Object</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../oracle/olapi/metadata/mdm/MdmObject.html#acceptVisitor(oracle.olapi.metadata.mdm.MdmObjectVisitor, java.lang.Object)">acceptVisitor</A></B>(<A HREF="../../../../oracle/olapi/metadata/mdm/MdmObjectVisitor.html" title="interface in oracle.olapi.metadata.mdm">MdmObjectVisitor</A> visitor, java.lang.Object context)</CODE> <BR> Calls a method of the specified <code>MdmObjectVisitor</code> and passes that method this <code>MdmObject</code> and an <code>Object</code>.</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="../../../../oracle/olapi/metadata/mdm/MdmObject.html#addDescription(oracle.olapi.metadata.mdm.MdmDescription)">addDescription</A></B>(<A HREF="../../../../oracle/olapi/metadata/mdm/MdmDescription.html" title="class in oracle.olapi.metadata.mdm">MdmDescription</A> desc)</CODE> <BR> Adds an <CODE>MdmDescription</CODE> to the descriptions that are associated with this <CODE>MdmObject</CODE>.</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="../../../../oracle/olapi/metadata/mdm/MdmObject.html#addObjectClassification(java.lang.String)">addObjectClassification</A></B>(java.lang.String classification)</CODE> <BR> Adds a classification to the <CODE>MdmObject</CODE>.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../oracle/olapi/metadata/mdm/MdmDescription.html" title="class in oracle.olapi.metadata.mdm">MdmDescription</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../oracle/olapi/metadata/mdm/MdmObject.html#findOrCreateDescription(oracle.olapi.metadata.mdm.MdmDescriptionType, java.lang.String)">findOrCreateDescription</A></B>(<A HREF="../../../../oracle/olapi/metadata/mdm/MdmDescriptionType.html" title="class in oracle.olapi.metadata.mdm">MdmDescriptionType</A> type, java.lang.String language)</CODE> <BR> Gets the <CODE>MdmDescription</CODE> of the specified type and language, if it exists.</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="../../../../oracle/olapi/metadata/mdm/MdmObject.html#getDescription()">getDescription</A></B>()</CODE> <BR> Gets a descriptive phrase for this <code>MdmObject</code>.</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="../../../../oracle/olapi/metadata/mdm/MdmObject.html#getDescription(oracle.olapi.metadata.mdm.MdmDescriptionType)">getDescription</A></B>(<A HREF="../../../../oracle/olapi/metadata/mdm/MdmDescriptionType.html" title="class in oracle.olapi.metadata.mdm">MdmDescriptionType</A> type)</CODE> <BR> Gets a description of the specified type for this <code>MdmObject</code> in the default language for the current session.</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="../../../../oracle/olapi/metadata/mdm/MdmObject.html#getDescription(oracle.olapi.metadata.mdm.MdmDescriptionType, java.lang.String)">getDescription</A></B>(<A HREF="../../../../oracle/olapi/metadata/mdm/MdmDescriptionType.html" title="class in oracle.olapi.metadata.mdm">MdmDescriptionType</A> type, java.lang.String language)</CODE> <BR> Gets a description of the specified type for this <code>MdmObject</code> in the specified.language.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> java.util.List</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../oracle/olapi/metadata/mdm/MdmObject.html#getDescriptions()">getDescriptions</A></B>()</CODE> <BR> Gets the <CODE>MdmDescription</CODE> objects that are associated with this <CODE>MdmObject</CODE>.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../oracle/olapi/metadata/mdm/MdmMetadataProvider.html" title="class in oracle.olapi.metadata.mdm">MdmMetadataProvider</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../oracle/olapi/metadata/mdm/MdmObject.html#getMetadataProvider()">getMetadataProvider</A></B>()</CODE> <BR> Gets the <code>MdmMetadataProvider</code> for this <code>MdmObject</code>.</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="../../../../oracle/olapi/metadata/mdm/MdmObject.html#getName()">getName</A></B>()</CODE> <BR> Gets the name of this <code>MdmObject</code>.</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="../../../../oracle/olapi/metadata/mdm/MdmObject.html#getNewName()">getNewName</A></B>()</CODE> <BR> Gets the name of this <code>MdmObject</code> if you have changed the name of the object by using the <code>setName</code> method but you have not committed the root transaction that contains the name change.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> java.util.List</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../oracle/olapi/metadata/mdm/MdmObject.html#getObjectClassifications()">getObjectClassifications</A></B>()</CODE> <BR> Gets a list of the classifications of the <CODE>MdmObject</CODE>.</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="../../../../oracle/olapi/metadata/mdm/MdmObject.html#getShortDescription()">getShortDescription</A></B>()</CODE> <BR> Gets the short description for this <code>MdmObject</code>.</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="../../../../oracle/olapi/metadata/mdm/MdmObject.html#isClassifiedAs(java.lang.String)">isClassifiedAs</A></B>(java.lang.String classification)</CODE> <BR> Indicates whether or not the <CODE>MdmObject</CODE> has the specified classification.</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="../../../../oracle/olapi/metadata/mdm/MdmObject.html#removeDescription(oracle.olapi.metadata.mdm.MdmDescription)">removeDescription</A></B>(<A HREF="../../../../oracle/olapi/metadata/mdm/MdmDescription.html" title="class in oracle.olapi.metadata.mdm">MdmDescription</A> desc)</CODE> <BR> Removes an <CODE>MdmDescription</CODE> from the descriptions that are associated with this <CODE>MdmObject</CODE>.</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="../../../../oracle/olapi/metadata/mdm/MdmObject.html#removeObjectClassification(java.lang.String)">removeObjectClassification</A></B>(java.lang.String classification)</CODE> <BR> Removes a classification from the <CODE>MdmObject</CODE>.</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="../../../../oracle/olapi/metadata/mdm/MdmObject.html#setDescription(oracle.olapi.metadata.mdm.MdmDescriptionType, java.lang.String)">setDescription</A></B>(<A HREF="../../../../oracle/olapi/metadata/mdm/MdmDescriptionType.html" title="class in oracle.olapi.metadata.mdm">MdmDescriptionType</A> type, java.lang.String value)</CODE> <BR> Specifies a description of the specified type for this <code>MdmObject</code> in the default language for the current session.</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="../../../../oracle/olapi/metadata/mdm/MdmObject.html#setDescription(oracle.olapi.metadata.mdm.MdmDescriptionType, java.lang.String, java.lang.String)">setDescription</A></B>(<A HREF="../../../../oracle/olapi/metadata/mdm/MdmDescriptionType.html" title="class in oracle.olapi.metadata.mdm">MdmDescriptionType</A> type, java.lang.String language, java.lang.String value)</CODE> <BR> Specifies a description of the specified type for this <code>MdmObject</code> in the specified language.</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="../../../../oracle/olapi/metadata/mdm/MdmObject.html#setDescription(java.lang.String)">setDescription</A></B>(java.lang.String description)</CODE> <BR> Specifies a descriptive phrase for this <code>MdmObject</code>.</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="../../../../oracle/olapi/metadata/mdm/MdmObject.html#setName(java.lang.String)">setName</A></B>(java.lang.String name)</CODE> <BR> Specifies a name for this <code>MdmObject</code>.</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="../../../../oracle/olapi/metadata/mdm/MdmObject.html#setShortDescription(java.lang.String)">setShortDescription</A></B>(java.lang.String description)</CODE> <BR> Specifies a short description for this <code>MdmObject</code>.</TD> </TR> </TABLE> <A NAME="methods_inherited_from_class_oracle.olapi.metadata.BaseMetadataObject"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> <TH ALIGN="left"><B>Methods inherited from class oracle.olapi.metadata.<A HREF="../../../../oracle/olapi/metadata/BaseMetadataObject.html" title="class in oracle.olapi.metadata">BaseMetadataObject</A></B></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><A HREF="../../../../oracle/olapi/metadata/BaseMetadataObject.html#getContainedByObject()">getContainedByObject</A>, <A HREF="../../../../oracle/olapi/metadata/BaseMetadataObject.html#getID()">getID</A>, <A HREF="../../../../oracle/olapi/metadata/BaseMetadataObject.html#getOwner()">getOwner</A></CODE></TD> </TR> </TABLE> <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD> </TR> </TABLE> <P> <!-- ============ METHOD DETAIL ========== --> <A NAME="method_detail"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> <B>Method Detail</B></FONT></TH> </TR> </TABLE> <A NAME="acceptVisitor(oracle.olapi.metadata.mdm.MdmObjectVisitor, java.lang.Object)"><!-- --></A><H3> acceptVisitor</H3> <PRE> public abstract java.lang.Object <B>acceptVisitor</B>(<A HREF="../../../../oracle/olapi/metadata/mdm/MdmObjectVisitor.html" title="interface in oracle.olapi.metadata.mdm">MdmObjectVisitor</A> visitor, java.lang.Object context)</PRE> <DL> <DD>Calls a method of the specified <code>MdmObjectVisitor</code> and passes that method this <code>MdmObject</code> and an <code>Object</code>. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>visitor</CODE> - An <code>MdmObjectVisitor</code>.<DD><CODE>context</CODE> - An <code>Object</code>. <DT><B>Returns:</B><DD>The <code>Object</code> returned by a method of the <code>MdmObjectVisitor</code>.</DL> </DD> </DL> <HR> <A NAME="getDescription()"><!-- --></A><H3> getDescription</H3> <PRE> public final java.lang.String <B>getDescription</B>() throws oracle.express.mdm.MetadataNotFoundException</PRE> <DL> <DD>Gets a descriptive phrase for this <code>MdmObject</code>. <P> <DD><DL> <DT><B>Returns:</B><DD>A descriptive phrase for this <code>MdmObject</code>. <DT><B>Throws:</B> <DD><CODE>oracle.express.mdm.MetadataNotFoundException</CODE> - Indicates that the requested metadata object does not exist or is not available to the <CODE>MdmMetadataProvider</CODE>.</DL> </DD> </DL> <HR> <A NAME="getMetadataProvider()"><!-- --></A><H3> getMetadataProvider</H3> <PRE> public <A HREF="../../../../oracle/olapi/metadata/mdm/MdmMetadataProvider.html" title="class in oracle.olapi.metadata.mdm">MdmMetadataProvider</A> <B>getMetadataProvider</B>()</PRE> <DL> <DD>Gets the <code>MdmMetadataProvider</code> for this <code>MdmObject</code>. <P> <DD><DL> <DT><B>Returns:</B><DD>The <code>MdmMetadataProvider</code> for this <code>MdmObject</code>.</DL> </DD> </DL> <HR> <A NAME="getName()"><!-- --></A><H3> getName</H3> <PRE> public java.lang.String <B>getName</B>() throws oracle.express.mdm.MetadataNotFoundException</PRE> <DL> <DD>Gets the name of this <code>MdmObject</code>. <P> <DD><DL> <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../oracle/olapi/metadata/BaseMetadataObject.html#getName()">getName</A></CODE> in class <CODE><A HREF="../../../../oracle/olapi/metadata/BaseMetadataObject.html" title="class in oracle.olapi.metadata">BaseMetadataObject</A></CODE></DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>A <code>String</code> that contains the name of this <code>MdmObject</code>. <DT><B>Throws:</B> <DD><CODE>oracle.express.mdm.MetadataNotFoundException</CODE> - Indicates that the requested metadata object does not exist or is not available to the <CODE>MdmMetadataProvider</CODE>.</DL> </DD> </DL> <HR> <A NAME="getShortDescription()"><!-- --></A><H3> getShortDescription</H3> <PRE> public java.lang.String <B>getShortDescription</B>() throws oracle.express.mdm.MetadataNotFoundException</PRE> <DL> <DD>Gets the short description for this <code>MdmObject</code>. You can use this description for display in a graphical user interface instead of the return value of the <code>getName</code> method. <P> <DD><DL> <DT><B>Returns:</B><DD>A <code>String</code> containing the short description of this <code>MdmObject</code>. <DT><B>Throws:</B> <DD><CODE>oracle.express.mdm.MetadataNotFoundException</CODE> - Indicates that the requested metadata object does not exist or is not available to the <CODE>MdmMetadataProvider</CODE>.</DL> </DD> </DL> <HR> <A NAME="setDescription(java.lang.String)"><!-- --></A><H3> setDescription</H3> <PRE> public final void <B>setDescription</B>(java.lang.String description)</PRE> <DL> <DD>Specifies a descriptive phrase for this <code>MdmObject</code>. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>description</CODE> - A <code>String</code> that contains a description for this <code>MdmObject</code>.</DL> </DD> </DL> <HR> <A NAME="setName(java.lang.String)"><!-- --></A><H3> setName</H3> <PRE> public void <B>setName</B>(java.lang.String name)</PRE> <DL> <DD>Specifies a name for this <code>MdmObject</code>. If the <code>MdmObject</code> already has a name, the new name does not take effect until the root transaction is committed. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>name</CODE> - A <code>String</code> that contains a name for this <code>MdmObject</code>.</DL> </DD> </DL> <HR> <A NAME="getNewName()"><!-- --></A><H3> getNewName</H3> <PRE> public final java.lang.String <B>getNewName</B>()</PRE> <DL> <DD>Gets the name of this <code>MdmObject</code> if you have changed the name of the object by using the <code>setName</code> method but you have not committed the root transaction that contains the name change. If you have not changed the name of this <code>MdmObject</code> since you last committed the root transaction, this method returns <code>null</code>. <P> <DD><DL> <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../oracle/olapi/metadata/BaseMetadataObject.html#getNewName()">getNewName</A></CODE> in class <CODE><A HREF="../../../../oracle/olapi/metadata/BaseMetadataObject.html" title="class in oracle.olapi.metadata">BaseMetadataObject</A></CODE></DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>The new name of this <code>MdmObject</code>, which takes effect after you commit the current root transaction, or <code>null</code> if you have not specified a new name.</DL> </DD> </DL> <HR> <A NAME="setShortDescription(java.lang.String)"><!-- --></A><H3> setShortDescription</H3> <PRE> public void <B>setShortDescription</B>(java.lang.String description) throws oracle.express.mdm.MetadataNotFoundException</PRE> <DL> <DD>Specifies a short description for this <code>MdmObject</code>. You can use this description for display in a graphical user interface instead of the return value of the <code>getName</code> method. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>description</CODE> - A <code>String</code> that contains a short description for this <code>MdmObject</code>. <DT><B>Throws:</B> <DD><CODE>oracle.express.mdm.MetadataNotFoundException</CODE> - Indicates that the requested metadata object does not exist or is not available to the <CODE>MdmMetadataProvider</CODE>.</DL> </DD> </DL> <HR> <A NAME="getObjectClassifications()"><!-- --></A><H3> getObjectClassifications</H3> <PRE> public final java.util.List <B>getObjectClassifications</B>()</PRE> <DL> <DD>Gets a list of the classifications of the <CODE>MdmObject</CODE>. <P> <DD><DL> <DT><B>Returns:</B><DD>A <CODE>List</CODE> of the classifications of the <CODE>MdmObject</CODE>.</DL> </DD> </DL> <HR> <A NAME="addObjectClassification(java.lang.String)"><!-- --></A><H3> addObjectClassification</H3> <PRE> public final void <B>addObjectClassification</B>(java.lang.String classification)</PRE> <DL> <DD>Adds a classification to the <CODE>MdmObject</CODE>. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>classification</CODE> - A <CODE>String</CODE> that contains the classification to add to the <CODE>MdmObject</CODE>.</DL> </DD> </DL> <HR> <A NAME="removeObjectClassification(java.lang.String)"><!-- --></A><H3> removeObjectClassification</H3> <PRE> public final void <B>removeObjectClassification</B>(java.lang.String classification)</PRE> <DL> <DD>Removes a classification from the <CODE>MdmObject</CODE>. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>classification</CODE> - A <CODE>String</CODE> that contains the classification to remove from the <CODE>MdmObject</CODE>.</DL> </DD> </DL> <HR> <A NAME="isClassifiedAs(java.lang.String)"><!-- --></A><H3> isClassifiedAs</H3> <PRE> public final boolean <B>isClassifiedAs</B>(java.lang.String classification)</PRE> <DL> <DD>Indicates whether or not the <CODE>MdmObject</CODE> has the specified classification. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>classification</CODE> - A <CODE>String</CODE> that contains the classification to compare to that of this <CODE>MdmObject</CODE>. <DT><B>Returns:</B><DD>A <CODE>boolean</CODE> that is <CODE>true</CODE> if the <CODE>MdmObject</CODE> has the specified classification or <CODE>false</CODE> if it does not.</DL> </DD> </DL> <HR> <A NAME="getDescription(oracle.olapi.metadata.mdm.MdmDescriptionType)"><!-- --></A><H3> getDescription</H3> <PRE> public final java.lang.String <B>getDescription</B>(<A HREF="../../../../oracle/olapi/metadata/mdm/MdmDescriptionType.html" title="class in oracle.olapi.metadata.mdm">MdmDescriptionType</A> type)</PRE> <DL> <DD>Gets a description of the specified type for this <code>MdmObject</code> in the default language for the current session. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>type</CODE> - An <CODE>MdmDescriptionType</CODE> that specifies the type of description, such as name or long description. <DT><B>Returns:</B><DD>A <CODE>String</CODE> that contains the descriptive value of the <CODE>MdmDescription</CODE> associated with the specified <CODE>MdmDescriptionType</CODE>.</DL> </DD> </DL> <HR> <A NAME="getDescription(oracle.olapi.metadata.mdm.MdmDescriptionType, java.lang.String)"><!-- --></A><H3> getDescription</H3> <PRE> public final java.lang.String <B>getDescription</B>(<A HREF="../../../../oracle/olapi/metadata/mdm/MdmDescriptionType.html" title="class in oracle.olapi.metadata.mdm">MdmDescriptionType</A> type, java.lang.String language)</PRE> <DL> <DD>Gets a description of the specified type for this <code>MdmObject</code> in the specified.language. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>type</CODE> - An <CODE>MdmDescriptionType</CODE> that specifies the type of description, such as short name or plural description.<DD><CODE>language</CODE> - A <CODE>String</CODE> that specifies the language for the description. <DT><B>Returns:</B><DD>A <CODE>String</CODE> that contains the descriptive value of the <CODE>MdmDescription</CODE> associated with the specified <CODE>MdmDescriptionType</CODE>.</DL> </DD> </DL> <HR> <A NAME="setDescription(oracle.olapi.metadata.mdm.MdmDescriptionType, java.lang.String)"><!-- --></A><H3> setDescription</H3> <PRE> public final void <B>setDescription</B>(<A HREF="../../../../oracle/olapi/metadata/mdm/MdmDescriptionType.html" title="class in oracle.olapi.metadata.mdm">MdmDescriptionType</A> type, java.lang.String value)</PRE> <DL> <DD>Specifies a description of the specified type for this <code>MdmObject</code> in the default language for the current session. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>type</CODE> - An <CODE>MdmDescriptionType</CODE> that specifies the type of description, such as name or long description.<DD><CODE>value</CODE> - A <code>String</code> that contains the description for this <code>MdmObject</code>.</DL> </DD> </DL> <HR> <A NAME="setDescription(oracle.olapi.metadata.mdm.MdmDescriptionType, java.lang.String, java.lang.String)"><!-- --></A><H3> setDescription</H3> <PRE> public final void <B>setDescription</B>(<A HREF="../../../../oracle/olapi/metadata/mdm/MdmDescriptionType.html" title="class in oracle.olapi.metadata.mdm">MdmDescriptionType</A> type, java.lang.String language, java.lang.String value)</PRE> <DL> <DD>Specifies a description of the specified type for this <code>MdmObject</code> in the specified language. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>type</CODE> - An <CODE>MdmDescriptionType</CODE> that specifies the type of description, such as name or long description.<DD><CODE>language</CODE> - A <CODE>String</CODE> that specifies the language for the description.<DD><CODE>value</CODE> - A <code>String</code> that contains the description for this <code>MdmObject</code>.</DL> </DD> </DL> <HR> <A NAME="findOrCreateDescription(oracle.olapi.metadata.mdm.MdmDescriptionType, java.lang.String)"><!-- --></A><H3> findOrCreateDescription</H3> <PRE> public <A HREF="../../../../oracle/olapi/metadata/mdm/MdmDescription.html" title="class in oracle.olapi.metadata.mdm">MdmDescription</A> <B>findOrCreateDescription</B>(<A HREF="../../../../oracle/olapi/metadata/mdm/MdmDescriptionType.html" title="class in oracle.olapi.metadata.mdm">MdmDescriptionType</A> type, java.lang.String language)</PRE> <DL> <DD>Gets the <CODE>MdmDescription</CODE> of the specified type and language, if it exists. Otherwise, creates an <CODE>MdmDescription</CODE> of the specified type and language. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>type</CODE> - An <CODE>MdmDescriptionType</CODE> that specifies the type of description, such as name or long description.<DD><CODE>language</CODE> - A <CODE>String</CODE> that specifies the language for the description. <DT><B>Returns:</B><DD>An <CODE>MdmDescription</CODE> of specified type and language with the specified value.</DL> </DD> </DL> <HR> <A NAME="getDescriptions()"><!-- --></A><H3> getDescriptions</H3> <PRE> public final java.util.List <B>getDescriptions</B>()</PRE> <DL> <DD>Gets the <CODE>MdmDescription</CODE> objects that are associated with this <CODE>MdmObject</CODE>. <P> <DD><DL> <DT><B>Returns:</B><DD>A <CODE>List</CODE> of the <CODE>MdmDescription</CODE> objects associated with this <CODE>MdmObject</CODE>.</DL> </DD> </DL> <HR> <A NAME="addDescription(oracle.olapi.metadata.mdm.MdmDescription)"><!-- --></A><H3> addDescription</H3> <PRE> public final void <B>addDescription</B>(<A HREF="../../../../oracle/olapi/metadata/mdm/MdmDescription.html" title="class in oracle.olapi.metadata.mdm">MdmDescription</A> desc)</PRE> <DL> <DD>Adds an <CODE>MdmDescription</CODE> to the descriptions that are associated with this <CODE>MdmObject</CODE>. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>desc</CODE> - The <CODE>MdmDescription</CODE> to add to this <CODE>MdmObject</CODE>.</DL> </DD> </DL> <HR> <A NAME="removeDescription(oracle.olapi.metadata.mdm.MdmDescription)"><!-- --></A><H3> removeDescription</H3> <PRE> public final void <B>removeDescription</B>(<A HREF="../../../../oracle/olapi/metadata/mdm/MdmDescription.html" title="class in oracle.olapi.metadata.mdm">MdmDescription</A> desc)</PRE> <DL> <DD>Removes an <CODE>MdmDescription</CODE> from the descriptions that are associated with this <CODE>MdmObject</CODE>. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>desc</CODE> - The <CODE>MdmDescription</CODE> to remove from this <CODE>MdmObject</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=2 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> </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"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </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="../../../../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> <center>Copyright © 2002, 2009, Oracle. All rights reserved.</center></EM> </TD> </TR> <TR> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../oracle/olapi/metadata/mdm/MdmNamedBuildProcess.html" title="class in oracle.olapi.metadata.mdm"><B>PREV CLASS</B></A> <A HREF="../../../../oracle/olapi/metadata/mdm/MdmObjectVisitor.html" title="interface in oracle.olapi.metadata.mdm"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../index.html?oracle/olapi/metadata/mdm/MdmObject.html" target="_top"><B>FRAMES</B></A> <A HREF="MdmObject.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 | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> </TR> </TABLE> <A NAME="skip-navbar_bottom"></A> <!-- ======== END OF BOTTOM NAVBAR ======= --> <HR> </BODY> </HTML>
Ms-Dos/Windows
Unix
Write backup
jsp File Browser version 1.2 by
www.vonloesch.de