<?xml version="1.0" encoding="Windows-1255" ?><Class name="ModelOrganizer" inherit="core.gml:Object" alias="index" id="core.gml:ModelOrganizer" sort="21" urn="core.gml:core.ModelOrganizer.gs" toc="\Core"><Summary>An object that can be used for organizing the model units into a navigable hierarchy.</Summary><Inherit>&lt;q ref=&quot;core.gml:Object&quot;&gt;Object&lt;/q&gt;</Inherit><Remarks>&lt;p&gt;
      The ModelOrganizer class implements the TreeProvider interface (see &lt;q ref=&quot;core.lib:TreeView&quot;&gt;TreeView&lt;/q&gt;).
      Therefore, it can be used to create TreeView controls for displaying and navigating
      the model's organizational hierarchy.
      &lt;/p&gt;&lt;p&gt;
      Instances of this class are created automatically by the system, and should
      not be created directly. To access the ModelOrganizer object of the currently
      open model use the Environment's &lt;q ref=&quot;core.env:Environment!organizer&quot;&gt;organizer&lt;/q&gt; property.
      &lt;/p&gt;</Remarks><Copyright>(c) SAP AG 2003-2006. All rights reserved.</Copyright>
<Topics>
<Property name="model" access="RO" type="gml:Model!" typeRef="&lt;q ref=&quot;core.gml:Model&quot;&gt;Model&lt;/q&gt;" sortGroup="true" scope="public" id="core.gml:ModelOrganizer!model" sort="34" group="Properties" seq="0000"><Summary>Gets the model organized by this object.</Summary></Property>
<Property name="root" access="RO" type="Unit!" typeRef="&lt;q ref=&quot;core.gml:Unit&quot;&gt;Unit&lt;/q&gt;" sortGroup="true" scope="public" id="core.gml:ModelOrganizer!root" sort="34" group="Properties" seq="0001"><Summary>Gets the root Unit of the Organizer.</Summary></Property>
<Method name="configSet" sortGroup="true" scope="public" id="core.gml:ModelOrganizer!configSet" sort="35" group="Methods" seq="0002"><Summary>Configs a set of elements.</Summary><Parameters signature="method:: &lt;i&gt;index&lt;/i&gt;.&lt;b&gt;configSet&lt;/b&gt;() &amp;rarr; treeNode[]"></Parameters><Return type="treeNode[]">return an array of tree nodes.</Return></Method>
<Method name="getAncestors" sortGroup="true" scope="public" id="core.gml:ModelOrganizer!getAncestors" sort="35" group="Methods" seq="0003"><Summary>Gets the ancestors chain of a given unit.</Summary><Parameters signature="method:: &lt;i&gt;index&lt;/i&gt;.&lt;b&gt;getAncestors&lt;/b&gt;(&lt;i&gt;unit&lt;/i&gt;) &amp;rarr; &lt;q ref=&quot;core.gml:Unit&quot;&gt;Unit&lt;/q&gt;[]"><Param name="unit" type="gml:Unit" typeRef="&lt;q ref=&quot;core.gml:Unit&quot;&gt;Unit&lt;/q&gt;">The given unit.</Param></Parameters><Return type="gml:Unit![]" typeRef="&lt;q ref=&quot;core.gml:Unit&quot;&gt;Unit&lt;/q&gt;[]">The list of the unit's ancestors, in nesting order.</Return></Method>
<Method name="getNodeId" sortGroup="true" scope="public" id="core.gml:ModelOrganizer!getNodeId" sort="35" group="Methods" seq="0004"><Summary>Gets the node id acourding to it's type:
	Unit :	unitId
	reusable Usage: containingUnit.usageId.targetUnitId
	not reusable Usage: targetUnitId
	other elements: containingUnitId.elementId.</Summary><Parameters signature="method:: &lt;i&gt;index&lt;/i&gt;.&lt;b&gt;getNodeId&lt;/b&gt;(&lt;i&gt;obj&lt;/i&gt;) &amp;rarr; void"><Param name="obj" type="GmlObject!" typeRef="&lt;q ref=&quot;core.gml:GmlObject&quot;&gt;GmlObject&lt;/q&gt;">A Gml object.</Param></Parameters><Return></Return></Method>
<Method name="getOrphansList" sortGroup="true" scope="public" id="core.gml:ModelOrganizer!getOrphansList" sort="35" group="Methods" seq="0005"><Summary>Gets the list of all orphan index nodes.</Summary><Parameters signature="method:: &lt;i&gt;index&lt;/i&gt;.&lt;b&gt;getOrphansList&lt;/b&gt;() &amp;rarr; String[id]"></Parameters><Return type="String[id]">The list of orphan index nodes.</Return></Method>
<Method name="getParent" sortGroup="true" scope="public" id="core.gml:ModelOrganizer!getParent" sort="35" group="Methods" seq="0006"><Summary>Gets the parent unit of a given unit.</Summary><Parameters signature="method:: &lt;i&gt;index&lt;/i&gt;.&lt;b&gt;getParent&lt;/b&gt;(&lt;i&gt;unit&lt;/i&gt;) &amp;rarr; &lt;q ref=&quot;core.gml:Unit&quot;&gt;Unit&lt;/q&gt;"><Param name="unit" type="gml:Unit" typeRef="&lt;q ref=&quot;core.gml:Unit&quot;&gt;Unit&lt;/q&gt;">The given unit.</Param></Parameters><Return type="gml:Unit!" typeRef="&lt;q ref=&quot;core.gml:Unit&quot;&gt;Unit&lt;/q&gt;">The parent unit.</Return></Method>
<Method name="getReusableUsages" sortGroup="true" scope="public" id="core.gml:ModelOrganizer!getReusableUsages" sort="35" group="Methods" seq="0007"><Summary>Gets only the reusables usages of a given unit.</Summary><Parameters signature="method:: &lt;i&gt;index&lt;/i&gt;.&lt;b&gt;getReusableUsages&lt;/b&gt;(&lt;i&gt;unit&lt;/i&gt;) &amp;rarr; &lt;q ref=&quot;core.gml:Unit&quot;&gt;Unit&lt;/q&gt;[]"><Param name="unit" type="gml:Unit!" typeRef="&lt;q ref=&quot;core.gml:Unit&quot;&gt;Unit&lt;/q&gt;">AN object of the type Unit.</Param></Parameters><Return type="gml:Unit![]" typeRef="&lt;q ref=&quot;core.gml:Unit&quot;&gt;Unit&lt;/q&gt;[]">Returns an array of reusable usages.</Return></Method>
<Method name="getRootId" sortGroup="true" scope="public" id="core.gml:ModelOrganizer!getRootId" sort="35" group="Methods" seq="0008"><Summary>Gets the root id of a given element.</Summary><Parameters label="Form 1" descr="" signature="method:: &lt;i&gt;index&lt;/i&gt;.&lt;b&gt;getRootId&lt;/b&gt;(&lt;i&gt;obj&lt;/i&gt;) &amp;rarr; void"><Param name="obj" type="Unit!" typeRef="&lt;q ref=&quot;core.gml:Unit&quot;&gt;Unit&lt;/q&gt;">An object of the type &lt;q ref=&quot;core.gml:Unit&quot;&gt;Unit&lt;/q&gt;</Param></Parameters><Parameters label="Form 2" descr="" signature="method:: &lt;i&gt;index&lt;/i&gt;.&lt;b&gt;getRootId&lt;/b&gt;(&lt;i&gt;obj&lt;/i&gt;) &amp;rarr; void"><Param name="obj" type="Element!" typeRef="&lt;q ref=&quot;core.gml:Element&quot;&gt;Element&lt;/q&gt;">An object of the type &lt;q ref=&quot;core.gml:Element&quot;&gt;Element&lt;/q&gt;</Param></Parameters><Return></Return></Method>
<Method name="getSubUnits" sortGroup="true" scope="public" id="core.gml:ModelOrganizer!getSubUnits" sort="35" group="Methods" seq="0009"><Summary>Gets the collection of sub-units of a given unit.</Summary><Parameters signature="method:: &lt;i&gt;index&lt;/i&gt;.&lt;b&gt;getSubUnits&lt;/b&gt;(&lt;i&gt;unit&lt;/i&gt;) &amp;rarr; &lt;q ref=&quot;core.gml:Unit&quot;&gt;Unit&lt;/q&gt;[id]"><Param name="unit" type="gml:Unit" typeRef="&lt;q ref=&quot;core.gml:Unit&quot;&gt;Unit&lt;/q&gt;">The given unit.</Param></Parameters><Return type="gml:Unit![id]" typeRef="&lt;q ref=&quot;core.gml:Unit&quot;&gt;Unit&lt;/q&gt;[id]">The requested sub-units collection.</Return></Method>
<Method name="hasChildren" sortGroup="true" scope="public" id="core.gml:ModelOrganizer!hasChildren" sort="35" group="Methods" seq="0010"><Summary>Provides a quick method for checking whether a given unit has any child-units.</Summary><Parameters signature="method:: &lt;i&gt;index&lt;/i&gt;.&lt;b&gt;hasChildren&lt;/b&gt;() &amp;rarr; Boolean"></Parameters><Return type="Boolean">return &lt;code&gt;true&lt;/code&gt; iff the unit has child units.</Return></Method>
<Method name="hasParent" sortGroup="true" scope="public" id="core.gml:ModelOrganizer!hasParent" sort="35" group="Methods" seq="0011"><Summary>Provides a quick method for checking whether a given unit has a parent unit.</Summary><Parameters signature="method:: &lt;i&gt;index&lt;/i&gt;.&lt;b&gt;hasParent&lt;/b&gt;(&lt;i&gt;unit&lt;/i&gt;) &amp;rarr; Boolean"><Param name="unit" type="gml:Unit" typeRef="&lt;q ref=&quot;core.gml:Unit&quot;&gt;Unit&lt;/q&gt;">The given unit.</Param></Parameters><Return type="Boolean">The test result.</Return></Method>
<Method name="hasSubUnits" sortGroup="true" scope="public" id="core.gml:ModelOrganizer!hasSubUnits" sort="35" group="Methods" seq="0012"><Summary>Provides a quick method for checking whether a given unit has any sub-units.</Summary><Parameters signature="method:: &lt;i&gt;index&lt;/i&gt;.&lt;b&gt;hasSubUnits&lt;/b&gt;(&lt;i&gt;unit&lt;/i&gt;) &amp;rarr; Boolean"><Param name="unit" type="gml:Unit" typeRef="&lt;q ref=&quot;core.gml:Unit&quot;&gt;Unit&lt;/q&gt;">The given unit.</Param></Parameters><Return type="Boolean">The test result.</Return></Method>
<Method name="isReusable" sortGroup="true" scope="public" id="core.gml:ModelOrganizer!isReusable" sort="35" group="Methods" seq="0013"><Summary>Tests whether the unit is a reusable unit.</Summary><Parameters signature="method:: &lt;i&gt;index&lt;/i&gt;.&lt;b&gt;isReusable&lt;/b&gt;() &amp;rarr; Boolean"></Parameters><Return type="Boolean">Return &lt;code&gt;true&lt;/code&gt; iff the usage is a reusable usage.</Return></Method>
<Method name="pasteAsLink" scope="protected" sortGroup="true" id="core.gml:ModelOrganizer!pasteAsLink" sort="35" group="Methods" seq="0014"><Summary>paste a usage as link.</Summary><Parameters signature="protected method:: &lt;i&gt;index&lt;/i&gt;.&lt;b&gt;pasteAsLink&lt;/b&gt;() &amp;rarr; void"></Parameters><Return></Return></Method>
<Method name="pasteAsLinkToBoard" scope="protected" sortGroup="true" id="core.gml:ModelOrganizer!pasteAsLinkToBoard" sort="35" group="Methods" seq="0015"><Summary>paste a usage as link.</Summary><Parameters signature="protected method:: &lt;i&gt;index&lt;/i&gt;.&lt;b&gt;pasteAsLinkToBoard&lt;/b&gt;() &amp;rarr; void"></Parameters><Return></Return></Method>
</Topics>
</Class>