<?xml version="1.0" encoding="Windows-1255" ?><Class name="Infoshape" inherit="core.gml:Configuration" implement="core.dev:IInfoshape" hierarchy="GMLDOM" also="core.gml:Configurable core.gml:Field core.gml:RefInfoshape core.gml:BOInfoshape" id="core.gml:Infoshape" sort="21" urn="core.gml:elements.Infoshape.gs" toc="\Elements"><Summary>The Infoshape is an element that contains a configurable collection of fields.
   This is an abstract class.</Summary><Inherit>&lt;q ref=&quot;core.gml:Configuration&quot;&gt;Configuration&lt;/q&gt;</Inherit><Implement>&lt;q ref=&quot;core.dev:IInfoshape&quot;&gt;IInfoshape&lt;/q&gt;</Implement><Copyright>(c) SAP AG 2003-2006. All rights reserved.</Copyright><SeeAlso>&lt;q ref=&quot;core.gml:Configurable&quot;&gt;Configurable&lt;/q&gt; | &lt;q ref=&quot;core.gml:Field&quot;&gt;Field&lt;/q&gt; | &lt;q ref=&quot;core.gml:RefInfoshape&quot;&gt;RefInfoshape&lt;/q&gt; | &lt;q ref=&quot;core.gml:BOInfoshape&quot;&gt;BOInfoshape&lt;/q&gt;</SeeAlso>
<Topics>
<Property name="items" strong="Yes" type="core.gml:Field![id]" modifier="strong" typeRef="&lt;q ref=&quot;core.gml:Field&quot;&gt;Field&lt;/q&gt;[id]" access="RW" sortGroup="true" scope="public" id="core.gml:Infoshape!items" sort="34" group="Properties" seq="0000"><Summary>The fields contained in this Infoshape. use &lt;q ref=&quot;core.gml:Infoshape!createField&quot;&gt;createField&lt;/q&gt; and &lt;q ref=&quot;core.gml:Infoshape!removeField&quot;&gt;removeField&lt;/q&gt; to add or remove them.</Summary></Property>
<Method name="createField" sortGroup="true" scope="public" id="core.gml:Infoshape!createField" sort="35" group="Methods" seq="0001"><Summary>Wrapper method for creating fields in &lt;q ref=&quot;core.gml:Infoshape&quot;&gt;Infoshape&lt;/q&gt;. Use this method instead of &lt;q ref=&quot;core.gml:TransObject!createElement&quot;&gt;createElement&lt;/q&gt;</Summary><Parameters signature="method:: &lt;i&gt;this&lt;/i&gt;.&lt;b&gt;createField&lt;/b&gt;(&lt;i&gt;field_class&lt;/i&gt;, &lt;i&gt;values&lt;/i&gt;) &amp;rarr; &lt;q ref=&quot;core.gml:Field&quot;&gt;Field&lt;/q&gt;"><Param name="field_class" type="String">The class name of the field object.</Param><Param name="values" default="" type="Variant[id]">A collection of property values for initializing the new element.</Param></Parameters><Return type="gml:Field" typeRef="&lt;q ref=&quot;core.gml:Field&quot;&gt;Field&lt;/q&gt;">the new field that was successfully created and inserted, or &lt;code&gt;null&lt;/code&gt;</Return></Method>
<Method name="getAlias" sortGroup="true" scope="public" id="core.gml:Infoshape!getAlias" sort="35" group="Methods" seq="0002"><Summary>Gets the infoshape's friendly name (alias).</Summary><Parameters signature="method:: &lt;i&gt;this&lt;/i&gt;.&lt;b&gt;getAlias&lt;/b&gt;() &amp;rarr; String"></Parameters><Return type="String">The infoshape's friendly name.</Return></Method>
<Method name="getAppName" sortGroup="true" scope="public" id="core.gml:Infoshape!getAppName" sort="35" group="Methods" seq="0003"><Summary>Gets the string representation of the application-specific technical infoshape name.</Summary><Parameters signature="method:: &lt;i&gt;this&lt;/i&gt;.&lt;b&gt;getAppName&lt;/b&gt;() &amp;rarr; String"></Parameters><Return type="String">The application-specific technical infoshape name.</Return></Method>
<Method name="getAppType" sortGroup="true" scope="public" id="core.gml:Infoshape!getAppType" sort="35" group="Methods" seq="0004"><Summary>Gets the string representation of the application-specific technical infoshape type.</Summary><Parameters signature="method:: &lt;i&gt;this&lt;/i&gt;.&lt;b&gt;getAppType&lt;/b&gt;() &amp;rarr; String"></Parameters><Return type="String">The application-specific technical infoshape type.</Return></Method>
<Method name="getDescription" sortGroup="true" scope="public" id="core.gml:Infoshape!getDescription" sort="35" group="Methods" seq="0005"><Summary>Gets the infoshape's description, as retrieved from the backend.</Summary><Parameters signature="method:: &lt;i&gt;this&lt;/i&gt;.&lt;b&gt;getDescription&lt;/b&gt;() &amp;rarr; String"></Parameters><Return type="String">The infoshape's description.</Return></Method>
<Method name="getFieldById" sortGroup="true" scope="public" id="core.gml:Infoshape!getFieldById" sort="35" group="Methods" seq="0006"><Summary>Gets a Field in this Infoshape by its ID.</Summary><Parameters signature="method:: &lt;i&gt;this&lt;/i&gt;.&lt;b&gt;getFieldById&lt;/b&gt;(&lt;i&gt;fieldId&lt;/i&gt;) &amp;rarr; &lt;q ref=&quot;core.dev:IField&quot;&gt;IField&lt;/q&gt;"><Param name="fieldId" type="String">The id of the field to retrieve.</Param></Parameters><Return type="dev:IField!" typeRef="&lt;q ref=&quot;core.dev:IField&quot;&gt;IField&lt;/q&gt;">The retrieved &lt;q ref=&quot;core.dev:IField&quot;&gt;IField&lt;/q&gt; element.</Return></Method>
<Method name="getFields" sortGroup="true" scope="public" id="core.gml:Infoshape!getFields" sort="35" group="Methods" seq="0007"><Summary>Gets collection of the Fields that belong to this Infoshape.</Summary><Parameters signature="method:: &lt;i&gt;this&lt;/i&gt;.&lt;b&gt;getFields&lt;/b&gt;() &amp;rarr; &lt;q ref=&quot;core.gml:Field&quot;&gt;Field&lt;/q&gt;[id]"></Parameters><Return type="gml:Field![id]" typeRef="&lt;q ref=&quot;core.gml:Field&quot;&gt;Field&lt;/q&gt;[id]">Collection of &lt;q ref=&quot;core.gml:Field&quot;&gt;Field&lt;/q&gt; elements.</Return></Method>
<Method name="getId" sortGroup="true" scope="public" id="core.gml:Infoshape!getId" sort="35" group="Methods" seq="0008"><Summary></Summary><Parameters signature="method:: &lt;i&gt;this&lt;/i&gt;.&lt;b&gt;getId&lt;/b&gt;() &amp;rarr; String"></Parameters><Return type="String">The infoshape's GML id.</Return></Method>
<Method name="getLabel" sortGroup="true" scope="public" id="core.gml:Infoshape!getLabel" sort="35" group="Methods" seq="0009"><Summary>Gets the infoshape's label, as retrieved from the backend.</Summary><Parameters signature="method:: &lt;i&gt;this&lt;/i&gt;.&lt;b&gt;getLabel&lt;/b&gt;() &amp;rarr; String"></Parameters><Return type="String">The infoshape's label.</Return></Method>
<Method name="getName" sortGroup="true" scope="public" id="core.gml:Infoshape!getName" sort="35" group="Methods" seq="0010"><Summary>Gets the infoshape's unique identifier. 
   It should consist of letters, digits or '_', and not start with a digit.
   It is unique in the scope of all infoshapes and fields with the same parent infoshape.</Summary><Parameters signature="method:: &lt;i&gt;this&lt;/i&gt;.&lt;b&gt;getName&lt;/b&gt;() &amp;rarr; String"></Parameters><Return type="String">The infoshape's unique identifier.</Return></Method>
<Method name="getType" sortGroup="true" scope="public" id="core.gml:Infoshape!getType" sort="35" group="Methods" seq="0011"><Summary>Gets the infoshape's type.</Summary><Parameters signature="method:: &lt;i&gt;this&lt;/i&gt;.&lt;b&gt;getType&lt;/b&gt;() &amp;rarr; String"></Parameters><Return type="String">The infoshape's type.</Return></Method>
<Method name="isCompatible" abstract="Yes" modifier="abstract" sortGroup="true" scope="public" id="core.gml:Infoshape!isCompatible" sort="35" group="Methods" seq="0012"><Summary>Tests compatibility between two infoshapes. This method is overriden by derived classes.</Summary><Parameters signature="method:: &lt;i&gt;this&lt;/i&gt;.&lt;b&gt;isCompatible&lt;/b&gt;(&lt;i&gt;other_infoshape&lt;/i&gt;) &amp;rarr; Boolean&lt;i&gt;Abstract=&quot;Yes&quot;&lt;/i&gt;"><Param name="other_infoshape" type="Infoshape">Another infoshape to be compared.</Param></Parameters><Return type="Boolean">Returns &lt;code&gt;true&lt;/code&gt; if infoshapes are compatible; otherwise, returns &lt;code&gt;false&lt;/code&gt;</Return></Method>
<Method name="notifyOnChange" abstract="Yes" modifier="abstract" sortGroup="true" scope="public" id="core.gml:Infoshape!notifyOnChange" sort="35" group="Methods" seq="0013"><Summary>Notify on changes that occurred in the infoshape.</Summary><Parameters signature="method:: &lt;i&gt;this&lt;/i&gt;.&lt;b&gt;notifyOnChange&lt;/b&gt;(&lt;i&gt;changeType&lt;/i&gt;, &lt;i&gt;changeData&lt;/i&gt;) &amp;rarr; void&lt;i&gt;Abstract=&quot;Yes&quot;&lt;/i&gt;"><Param name="changeType" type="gml:Infoshape!INFOSHAPE_CHANGE" typeRef="&lt;q ref=&quot;core.gml:Infoshape!INFOSHAPE_CHANGE&quot;&gt;INFOSHAPE_CHANGE&lt;/q&gt;">the type of change of infoshape.</Param><Param name="changeData" type="Variant">An object containing data related to the change in the infoshape.</Param></Parameters><Return></Return><Remarks>&lt;code&gt;changeData&lt;/code&gt; object contains members that represent the change in the infoshape.
      &lt;h2&gt;INFOSHAPE_CHANGE_NONE&lt;/h2&gt;
      changeData is null.
      &lt;h2&gt;INFOSHAPE_CHANGE_FIELD_ADD, INFOSHAPE_CHANGE_FIELD_DELETE&lt;/h2&gt;
      changeData contain these members
      &lt;table class=&quot;BOTH&quot;&gt;&lt;tr&gt;&lt;td class=&quot;H V&quot;&gt;Member &lt;/td&gt;&lt;td class=H&gt;Type &lt;/td&gt;&lt;td class=H&gt;Description &lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td class=V&gt;fields &lt;/td&gt;&lt;td&gt;&lt;q ref=&quot;core.gml:Field&quot;&gt;Field&lt;/q&gt;[] &lt;/td&gt;&lt;td&gt;Array of added/deleted fields. Must contain at least one field. &lt;/td&gt;&lt;/tr&gt;&lt;/table&gt;

      &lt;h2&gt;INFOSHAPE_CHANGE_FIELD_UPDATE&lt;/h2&gt;
      changeData contain these members
      &lt;table class=&quot;BOTH&quot;&gt;&lt;tr&gt;&lt;td class=&quot;H V&quot;&gt;Member &lt;/td&gt;&lt;td class=H&gt;Type &lt;/td&gt;&lt;td class=H&gt;Description &lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td class=V&gt;field &lt;/td&gt;&lt;td&gt;&lt;q ref=&quot;core.gml:Field&quot;&gt;Field&lt;/q&gt; &lt;/td&gt;&lt;td&gt;Modified field &lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td class=V&gt;evt &lt;/td&gt;&lt;td&gt;&lt;q ref=&quot;core.gml:GmlObject!onUpdateObject&quot;&gt;onUpdateObject&lt;/q&gt; event &lt;/td&gt;&lt;td&gt;The event representing the field's modification. &lt;/td&gt;&lt;/tr&gt;&lt;/table&gt;

      &lt;h2&gt;INFOSHAPE_CHANGE_BO_REPLACED&lt;/h2&gt;
      changeData contain these members
      &lt;table class=&quot;BOTH&quot;&gt;&lt;tr&gt;&lt;td class=&quot;H V&quot;&gt;Member &lt;/td&gt;&lt;td class=H&gt;Type &lt;/td&gt;&lt;td class=H&gt;Description &lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td class=V&gt;old_bo &lt;/td&gt;&lt;td&gt;id &lt;/td&gt;&lt;td&gt;bo id of the old &lt;q ref=&quot;core.gml:BOInfoshape&quot;&gt;BOInfoshape&lt;/q&gt; &lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td class=V&gt;new_bo &lt;/td&gt;&lt;td&gt;id &lt;/td&gt;&lt;td&gt;bo id of the new &lt;q ref=&quot;core.gml:BOInfoshape&quot;&gt;BOInfoshape&lt;/q&gt; &lt;/td&gt;&lt;/tr&gt;&lt;/table&gt;

      &lt;h2&gt;INFOSHAPE_CHANGE_REF_REPLACED&lt;/h2&gt;
      changeData contain these members
      &lt;table class=&quot;BOTH&quot;&gt;&lt;tr&gt;&lt;td class=&quot;H V&quot;&gt;Member &lt;/td&gt;&lt;td class=H&gt;Type &lt;/td&gt;&lt;td class=H&gt;Description &lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td class=V&gt;old_ref &lt;/td&gt;&lt;td&gt;id &lt;/td&gt;&lt;td&gt;id of the old &lt;q ref=&quot;core.gml:RefInfoshape&quot;&gt;RefInfoshape&lt;/q&gt; &lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td class=V&gt;new_ref &lt;/td&gt;&lt;td&gt;id &lt;/td&gt;&lt;td&gt;id of the new &lt;q ref=&quot;core.gml:RefInfoshape&quot;&gt;RefInfoshape&lt;/q&gt; &lt;/td&gt;&lt;/tr&gt;&lt;/table&gt;</Remarks></Method>
<Method name="removeField" sortGroup="true" scope="public" id="core.gml:Infoshape!removeField" sort="35" group="Methods" seq="0014"><Summary>Wrapper method for removing a field in &lt;q ref=&quot;core.gml:Infoshape&quot;&gt;Infoshape&lt;/q&gt;. Use this method instead of &lt;q ref=&quot;core.gml:TransObject!removeElement&quot;&gt;removeElement&lt;/q&gt;</Summary><Parameters label="Form 1" descr="" signature="method:: &lt;i&gt;this&lt;/i&gt;.&lt;b&gt;removeField&lt;/b&gt;(&lt;i&gt;field&lt;/i&gt;) &amp;rarr; Boolean"><Param name="field" type="gml:Element" typeRef="&lt;q ref=&quot;core.gml:Element&quot;&gt;Element&lt;/q&gt;">The field child element to remove.</Param></Parameters><Parameters label="Form 2" descr="" signature="method:: &lt;i&gt;this&lt;/i&gt;.&lt;b&gt;removeField&lt;/b&gt;(&lt;i&gt;id&lt;/i&gt;) &amp;rarr; Boolean"><Param name="id" type="String">The Id of the field child element to remove.</Param></Parameters><Return type="Boolean">Indicates whether the field child element was successfully removed.</Return></Method>
<Enumeration name="INFOSHAPE_CHANGE" sortGroup="true" id="core.gml:Infoshape!INFOSHAPE_CHANGE" sort="42" group="Enumerations" seq="0015"><Summary>An enumeration of the type of change in the infoshape.</Summary><Remarks>The available field sources are  listed below:
   &lt;table class=&quot;BOTH&quot;&gt;&lt;tr&gt;&lt;td class=&quot;H V&quot;&gt;Type &lt;/td&gt;&lt;td class=H&gt;Description &lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td class=V&gt;INFOSHAPE_CHANGE_NONE &lt;/td&gt;&lt;td&gt;No change &lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td class=V&gt;INFOSHAPE_CHANGE_FIELD_ADD &lt;/td&gt;&lt;td&gt;Fields added to infoshape &lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td class=V&gt;INFOSHAPE_CHANGE_FIELD_DELETE &lt;/td&gt;&lt;td&gt;Fields removed from infoshape &lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td class=V&gt;INFOSHAPE_CHANGE_FIELD_UPDATE &lt;/td&gt;&lt;td&gt;Field updated in infoshape &lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td class=V&gt;INFOSHAPE_CHANGE_BO_REPLACED &lt;/td&gt;&lt;td&gt;RefInfoshape now points to a new BO infoshape &lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td class=V&gt;INFOSHAPE_CHANGE_REF_REPLACED &lt;/td&gt;&lt;td&gt;Configurable element has new RefInfoshape &lt;/td&gt;&lt;/tr&gt;&lt;/table&gt;</Remarks></Enumeration>
</Topics>
</Class>