<?xml version="1.0" encoding="Windows-1255" ?><Class name="InfoshapePool" inherit="core.gml:Unit" alias="pool" hierarchy="GMLDOM" id="core.gml:InfoshapePool" sort="21" urn="core.gml:diagrams.InfoshapePool.gs" toc="\Diagrams"><Summary>The InfoshapePool is the unit that stores all infoshapes in the model.</Summary><Inherit>&lt;q ref=&quot;core.gml:Unit&quot;&gt;Unit&lt;/q&gt;</Inherit><Remarks>&lt;ul&gt;&lt;li&gt;The infoshape pool stores all &lt;q ref=&quot;core.gml:RefInfoshape&quot;&gt;RefInfoshape&lt;/q&gt; objects in the model. In addition, it stoers usages to all &lt;q ref=&quot;core.gml:BOInfoshapeUnit&quot;&gt;BOInfoshapeUnit&lt;/q&gt; units. &lt;/li&gt;&lt;li&gt;Infohsape pool also handles notification on changes in infoshapes in the model. &lt;/li&gt;&lt;/ul&gt;</Remarks><Copyright>(c) SAP AG 2003-2006. All rights reserved.</Copyright>
<Topics>
<Property name="BOInfoshapeMap" virtual="Yes" type="core.gml:BOInfoshapeUsage![id]" modifier="virtual" typeRef="&lt;q ref=&quot;core.gml:BOInfoshapeUsage&quot;&gt;BOInfoshapeUsage&lt;/q&gt;[id]" access="RW" sortGroup="true" scope="public" id="core.gml:InfoshapePool!BOInfoshapeMap" sort="34" group="Properties" seq="0000"><Summary>Collection for optimizations: All &lt;q ref=&quot;core.gml:BOInfoshapeUsage&quot;&gt;BOInfoshapeUsage&lt;/q&gt; objects stored in this unit, indexed by the unique id. (&lt;q ref=&quot;core.gml:BOInfoshape!bo_id&quot;&gt;bo_id&lt;/q&gt;);Actor.</Summary></Property>
<Method name="cleanAll" sortGroup="true" scope="public" id="core.gml:InfoshapePool!cleanAll" sort="35" group="Methods" seq="0001"><Summary>Cleans the entire infoshape pool - should be used only when a floorplan is deleted.</Summary><Parameters signature="method:: &lt;i&gt;pool&lt;/i&gt;.&lt;b&gt;cleanAll&lt;/b&gt;() &amp;rarr; void"></Parameters><Return></Return></Method>
<Method name="cloneBOInfoshapeUnit" sortGroup="true" scope="public" id="core.gml:InfoshapePool!cloneBOInfoshapeUnit" sort="35" group="Methods" seq="0002"><Summary>Clone  &lt;q ref=&quot;core.gml:BOInfoshapeUnit&quot;&gt;BOInfoshapeUnit&lt;/q&gt; with a given backend ID.</Summary><Parameters signature="method:: &lt;i&gt;pool&lt;/i&gt;.&lt;b&gt;cloneBOInfoshapeUnit&lt;/b&gt;(&lt;i&gt;BOInfoshapeUnit&lt;/i&gt;, &lt;i&gt;bo_id&lt;/i&gt;) &amp;rarr; core.gml:BOInfoshapeUnit"><Param name="BOInfoshapeUnit" type="core.gml:BOInfoshapeUnit">The &lt;q ref=&quot;core.gml:InfoshapePool!core&quot;&gt;core&lt;/q&gt;.gml:BOInfoshapeUnit! to clone.</Param><Param name="bo_id" type="string">The Backend ID for the cloned &lt;q ref=&quot;core.gml:BOInfoshape&quot;&gt;BOInfoshape&lt;/q&gt;</Param></Parameters><Return type="core.gml:BOInfoshapeUnit">The created infoshape unit, or &lt;code&gt;null&lt;/code&gt; if this &lt;q ref=&quot;core.gml:BOInfoshape&quot;&gt;BOInfoshape&lt;/q&gt; already exists.</Return><Remarks>&lt;b&gt;Note: &lt;/b&gt;This function returns &lt;code&gt;null&lt;/code&gt; if the backend ID of the cloned infoshape already exists.</Remarks></Method>
<Method name="createBOInfoshapeUnit" sortGroup="true" scope="public" id="core.gml:InfoshapePool!createBOInfoshapeUnit" sort="35" group="Methods" seq="0003"><Summary>create new &lt;q ref=&quot;core.gml:BOInfoshapeUnit&quot;&gt;BOInfoshapeUnit&lt;/q&gt; and inside it a &lt;q ref=&quot;core.gml:BOInfoshape&quot;&gt;BOInfoshape&lt;/q&gt; object with a given backend ID. Put a usage for the created unit in the infoshape pool.</Summary><Parameters label="Form 1" descr="create new &lt;q ref=&quot;core.gml:BOInfoshapeUnit&quot;&gt;BOInfoshapeUnit&lt;/q&gt; and inside it a &lt;q ref=&quot;core.gml:BOInfoshape&quot;&gt;BOInfoshape&lt;/q&gt; object with a given backend ID. Put a usage for the created unit in the infoshape pool." signature="method:: &lt;i&gt;pool&lt;/i&gt;.&lt;b&gt;createBOInfoshapeUnit&lt;/b&gt;(&lt;i&gt;aBOInfoshape&lt;/i&gt;, &lt;i&gt;aBOName&lt;/i&gt;, &lt;i&gt;aBOId&lt;/i&gt;) &amp;rarr; core.gml:BOInfoshapeUnit"><Param name="aBOInfoshape" type="string">The class name for the &lt;q ref=&quot;core.gml:BOInfoshape&quot;&gt;BOInfoshape&lt;/q&gt; object that is created inside the &lt;q ref=&quot;core.gml:BOInfoshapeUnit&quot;&gt;BOInfoshapeUnit&lt;/q&gt; unit.</Param><Param name="aBOName" type="string">The name for the created unit and its usgae.</Param><Param name="aBOId" type="string">The Backend ID for the created &lt;q ref=&quot;core.gml:BOInfoshape&quot;&gt;BOInfoshape&lt;/q&gt;</Param></Parameters><Parameters label="Form 2" descr="create new &lt;q ref=&quot;core.gml:BOInfoshapeUnit&quot;&gt;BOInfoshapeUnit&lt;/q&gt; and insert the &lt;q ref=&quot;core.gml:BOInfoshape&quot;&gt;BOInfoshape&lt;/q&gt; object into it with a given backend ID. Put a usage for the created unit in the infoshape pool." signature="method:: &lt;i&gt;pool&lt;/i&gt;.&lt;b&gt;createBOInfoshapeUnit&lt;/b&gt;(&lt;i&gt;aBOInfoshape&lt;/i&gt;, &lt;i&gt;aBOName&lt;/i&gt;, &lt;i&gt;aBOId&lt;/i&gt;) &amp;rarr; core.gml:BOInfoshapeUnit"><Param name="aBOInfoshape" type="core.gml:Infoshape">The  &lt;q ref=&quot;core.gml:BOInfoshape&quot;&gt;BOInfoshape&lt;/q&gt; object that will be inserted into the &lt;q ref=&quot;core.gml:BOInfoshapeUnit&quot;&gt;BOInfoshapeUnit&lt;/q&gt; unit.</Param><Param name="aBOName" type="string">The name for the created unit and its usgae.</Param><Param name="aBOId" type="string">The Backend ID for the created &lt;q ref=&quot;core.gml:BOInfoshape&quot;&gt;BOInfoshape&lt;/q&gt;</Param></Parameters><Return type="core.gml:BOInfoshapeUnit">The created infoshape unit, or &lt;code&gt;null&lt;/code&gt; if this &lt;q ref=&quot;core.gml:BOInfoshape&quot;&gt;BOInfoshape&lt;/q&gt; already exists.</Return><Remarks>&lt;b&gt;Note: &lt;/b&gt;This function returns &lt;code&gt;null&lt;/code&gt; if the backend ID of the created infoshape already exists.</Remarks></Method>
<Method name="createNewBOInfoshapeUnit" sortGroup="true" scope="public" id="core.gml:InfoshapePool!createNewBOInfoshapeUnit" sort="35" group="Methods" seq="0004"><Summary>create new &lt;q ref=&quot;core.gml:BOInfoshapeUnit&quot;&gt;BOInfoshapeUnit&lt;/q&gt; and inside it a &lt;q ref=&quot;core.gml:BOInfoshape&quot;&gt;BOInfoshape&lt;/q&gt; object with a given backend ID. Put a usage for the created unit in the infoshape pool.</Summary><Parameters signature="method:: &lt;i&gt;pool&lt;/i&gt;.&lt;b&gt;createNewBOInfoshapeUnit&lt;/b&gt;(&lt;i&gt;bo_infoshape_class&lt;/i&gt;, &lt;i&gt;bo_name&lt;/i&gt;, &lt;i&gt;bo_id&lt;/i&gt;) &amp;rarr; core.gml:BOInfoshapeUnit"><Param name="bo_infoshape_class" type="string">The class name for the &lt;q ref=&quot;core.gml:BOInfoshape&quot;&gt;BOInfoshape&lt;/q&gt; object that is created inside the &lt;q ref=&quot;core.gml:BOInfoshapeUnit&quot;&gt;BOInfoshapeUnit&lt;/q&gt; unit.</Param><Param name="bo_name" type="string">The name for the created unit and its usgae.</Param><Param name="bo_id" type="string">The Backend ID for the created &lt;q ref=&quot;core.gml:BOInfoshape&quot;&gt;BOInfoshape&lt;/q&gt;</Param></Parameters><Return type="core.gml:BOInfoshapeUnit">The created infoshape unit, or &lt;code&gt;null&lt;/code&gt; if this &lt;q ref=&quot;core.gml:BOInfoshape&quot;&gt;BOInfoshape&lt;/q&gt; already exists.</Return><Remarks>&lt;b&gt;Note: DEPRICATED.&lt;/b&gt;This function returns &lt;code&gt;null&lt;/code&gt; if the backend ID of the created infoshape already exists.</Remarks></Method>
<Method name="deleteBOInfoshapeUnit" sortGroup="true" scope="public" id="core.gml:InfoshapePool!deleteBOInfoshapeUnit" sort="35" group="Methods" seq="0005"><Summary>Delete a &lt;q ref=&quot;core.gml:InfoshapePool!BOInfoshapeUnit&quot;&gt;BOInfoshapeUnit&lt;/q&gt;</Summary><Parameters signature="method:: &lt;i&gt;pool&lt;/i&gt;.&lt;b&gt;deleteBOInfoshapeUnit&lt;/b&gt;(&lt;i&gt;bo_unit&lt;/i&gt;) &amp;rarr; Boolean"><Param name="bo_unit" type="BOInfoshapeUnit!" typeRef="&lt;q ref=&quot;core.gml:BOInfoshapeUnit&quot;&gt;BOInfoshapeUnit&lt;/q&gt;">The unit to delete.</Param></Parameters><Return type="Boolean">true if succeeded in deleting, false if failed for some reason.</Return><Remarks>This method first checks if this BOInfoshape is in use by and elements.
Then it deletes all RefInfoshapes (that contain BOInfoshapeUsage) to this BOInfoshapeUnit in order to delete it.
It also deletes the BOInfoshapeUsage in the infoshape pool.</Remarks></Method>
<Method name="getBOInfoshape" sortGroup="true" scope="public" id="core.gml:InfoshapePool!getBOInfoshape" sort="35" group="Methods" seq="0006"><Summary>Gets a global model &lt;q ref=&quot;core.gml:BOInfoshape&quot;&gt;BOInfoshape&lt;/q&gt; by its &lt;q ref=&quot;core.gml:BOInfoshape!bo_id&quot;&gt;bo_id&lt;/q&gt; (backend unique id).</Summary><Parameters signature="method:: &lt;i&gt;pool&lt;/i&gt;.&lt;b&gt;getBOInfoshape&lt;/b&gt;(&lt;i&gt;bo_id&lt;/i&gt;) &amp;rarr; core.gml:BOInfoshape"><Param name="bo_id" type="String">The backend ID of the requested &lt;q ref=&quot;core.gml:BOInfoshape&quot;&gt;BOInfoshape&lt;/q&gt; object.</Param></Parameters><Return type="core.gml:BOInfoshape">The &lt;q ref=&quot;core.gml:BOInfoshape&quot;&gt;BOInfoshape&lt;/q&gt; that was found, or &lt;code&gt;null&lt;/code&gt;</Return></Method>
<Method name="getRefInfoshape" sortGroup="true" scope="public" id="core.gml:InfoshapePool!getRefInfoshape" sort="35" group="Methods" seq="0007"><Summary>Gets a &lt;q ref=&quot;core.gml:RefInfoshape&quot;&gt;RefInfoshape&lt;/q&gt; object, using its GML ID.</Summary><Parameters signature="method:: &lt;i&gt;pool&lt;/i&gt;.&lt;b&gt;getRefInfoshape&lt;/b&gt;(&lt;i&gt;infoshape_id&lt;/i&gt;) &amp;rarr; core.gml:RefInfoshape"><Param name="infoshape_id" type="String">The GML ID of the requested &lt;q ref=&quot;core.gml:RefInfoshape&quot;&gt;RefInfoshape&lt;/q&gt; object.</Param></Parameters><Return type="core.gml:RefInfoshape">The &lt;q ref=&quot;core.gml:RefInfoshape&quot;&gt;RefInfoshape&lt;/q&gt; that was found.</Return></Method>
<Method name="removeRefInfoshape" sortGroup="true" scope="public" id="core.gml:InfoshapePool!removeRefInfoshape" sort="35" group="Methods" seq="0008"><Summary>Remove a refInfoshape from the infoshape pool.</Summary><Parameters signature="method:: &lt;i&gt;pool&lt;/i&gt;.&lt;b&gt;removeRefInfoshape&lt;/b&gt;() &amp;rarr; void"></Parameters><Return></Return></Method>
<Method name="storeInfoshape" sortGroup="true" scope="public" id="core.gml:InfoshapePool!storeInfoshape" sort="35" group="Methods" seq="0009"><Summary>store an infoshape in the infoshape pool. Can store &lt;q ref=&quot;core.gml:RefInfoshape&quot;&gt;RefInfoshape&lt;/q&gt; object.</Summary><Parameters signature="method:: &lt;i&gt;pool&lt;/i&gt;.&lt;b&gt;storeInfoshape&lt;/b&gt;(&lt;i&gt;infoshape_obj&lt;/i&gt;) &amp;rarr; void"><Param name="infoshape_obj" type="RefInfoshape!" typeRef="&lt;q ref=&quot;core.gml:RefInfoshape&quot;&gt;RefInfoshape&lt;/q&gt;">The &lt;q ref=&quot;core.gml:RefInfoshape&quot;&gt;RefInfoshape&lt;/q&gt; to store in the infoshape pool.</Param></Parameters><Return></Return></Method>
</Topics>
</Class>