<?xml version="1.0" encoding="Windows-1255" ?><Interface name="KitEnumerations" alias="$ENV" id="core.env:KitEnumerations" sort="23" urn="core.env:extensions.KitEnumerations.js" toc="\Extension Points"><Summary>Extension point for defining kit enumerations.</Summary><Copyright>(c) SAP AG 2003-2006. All rights reserved.</Copyright>
<Topics>
<Method name="defineEnumeration" sortGroup="true" scope="public" id="core.env:KitEnumerations!defineEnumeration" sort="35" group="Methods" seq="0000"><Summary>Defines a new enumeration.</Summary><Parameters label="Form 1" descr="" signature="method:: &lt;i&gt;$ENV&lt;/i&gt;.&lt;b&gt;defineEnumeration&lt;/b&gt;(&lt;i&gt;id&lt;/i&gt;, &lt;i&gt;enumData&lt;/i&gt;) &amp;rarr; &lt;q ref=&quot;core.lib:Global!ENUM_OBJ&quot;&gt;ENUM_OBJ&lt;/q&gt;"><Param name="id" type="QName">The enumeration id  - must be prefixed with namespace e.g. com.sap.mypackage:id.</Param><Param name="enumData" type="lib:Global!ENUM_OBJ" typeRef="&lt;q ref=&quot;core.lib:Global!ENUM_OBJ&quot;&gt;ENUM_OBJ&lt;/q&gt;">The enumeration object.</Param></Parameters><Parameters label="Form 2" descr="" signature="method:: &lt;i&gt;$ENV&lt;/i&gt;.&lt;b&gt;defineEnumeration&lt;/b&gt;(&lt;i&gt;id&lt;/i&gt;, &lt;i&gt;enumStr&lt;/i&gt;) &amp;rarr; &lt;q ref=&quot;core.lib:Global!ENUM_OBJ&quot;&gt;ENUM_OBJ&lt;/q&gt;"><Param name="id" type="QName">The enumeration id - must be prefixed with namespace e.g. com.sap.mypackage:id.</Param><Param name="enumStr" type="String">The enumeration in string representation.</Param></Parameters><Return type="lib:Global!ENUM_OBJ" typeRef="&lt;q ref=&quot;core.lib:Global!ENUM_OBJ&quot;&gt;ENUM_OBJ&lt;/q&gt;">The newly defined enumeration.</Return><Remarks>&lt;h2&gt;Xml definition of enumeration&lt;/h2&gt;
   &lt;pre&gt;
   &amp;lt;CONFIGURE type=&amp;quot;ENUMERATIONS&amp;quot;&amp;gt;
   ?  &amp;lt;HEADER&amp;gt;
   ?     &amp;lt;PRAGMA&amp;gt;# Pragmas section&amp;lt;/PRAGMA&amp;gt;
   ?     &amp;lt;SCRIPT&amp;gt;# Code section. Place here functions\variables
                   which you want to address from within the enumeration tags
         &amp;lt;/SCRIPT&amp;gt;
      &amp;lt;/HEADER&amp;gt;
      &amp;lt;ENUMERATIONS&amp;gt;
   +     &amp;lt;ENUMERATION id=&amp;quot;com.sap.mypackage:enumerationId&amp;quot;&amp;gt;
            &amp;lt;DATA type=&amp;quot;string&amp;quot;&amp;gt;
               # The enumeration in string representation
            &amp;lt;/DATA&amp;gt;
         &amp;lt;/ENUMERATION&amp;gt;

         or:

         &amp;lt;ENUMERATION id=&amp;quot;com.sap.mypackage:enumerationId&amp;quot;&amp;gt;
            &amp;lt;DATA type=&amp;quot;object&amp;quot;&amp;gt;
               # The enumeration object
                 The order of the items in the object here determins
                 the order in the enumeration (see example)
            &amp;lt;/DATA&amp;gt;
         &amp;lt;/ENUMERATION&amp;gt;
      &amp;lt;/ENUMERATIONS&amp;gt;
   &amp;lt;/CONFIGURE&amp;gt;
   &lt;/pre&gt;
   &lt;h2&gt;Example&lt;/h2&gt;
   &lt;pre&gt;
   &amp;lt;CONFIGURE type=&amp;quot;ENUMERATIONS&amp;quot;&amp;gt;
      &amp;lt;ENUMERATIONS&amp;gt;
         &amp;lt;ENUMERATION id=&amp;quot;TEXT_FONTS&amp;quot;&amp;gt;
            &amp;lt;DATA type=&amp;quot;string&amp;quot;&amp;gt;A:Normal;B:Emphasized;C:Italic;D:Underline&amp;lt;/DATA&amp;gt;
         &amp;lt;/ENUMERATION&amp;gt;
         &amp;lt;ENUMERATION id=&amp;quot;BOOL&amp;quot;&amp;gt;
            &amp;lt;DATA type=&amp;quot;object&amp;quot;&amp;gt;
               &amp;lt;a&amp;gt;yes&amp;lt;/a&amp;gt;
               &amp;lt;b&amp;gt;No&amp;lt;/b&amp;gt;
            &amp;lt;/DATA&amp;gt;
         &amp;lt;/ENUMERATION&amp;gt;
      &amp;lt;/ENUMERATIONS&amp;gt;
   &amp;lt;/CONFIGURE&amp;gt;
   &lt;/pre&gt;</Remarks></Method>
<Method name="getEnumeration" sortGroup="true" scope="public" id="core.env:KitEnumerations!getEnumeration" sort="35" group="Methods" seq="0001"><Summary>Returns a specified enumeration.</Summary><Parameters signature="method:: &lt;i&gt;$ENV&lt;/i&gt;.&lt;b&gt;getEnumeration&lt;/b&gt;(&lt;i&gt;id&lt;/i&gt;) &amp;rarr; &lt;q ref=&quot;core.lib:Global!ENUM_OBJ&quot;&gt;ENUM_OBJ&lt;/q&gt;"><Param name="id" type="QName">The enumeration id.</Param></Parameters><Return type="lib:Global!ENUM_OBJ" typeRef="&lt;q ref=&quot;core.lib:Global!ENUM_OBJ&quot;&gt;ENUM_OBJ&lt;/q&gt;">The requested enumeration object.</Return></Method>
<Method name="getEnumerationsTable" sortGroup="true" scope="public" id="core.env:KitEnumerations!getEnumerationsTable" sort="35" group="Methods" seq="0002"><Summary>Returns the complete enumerations table.</Summary><Parameters signature="method:: &lt;i&gt;$ENV&lt;/i&gt;.&lt;b&gt;getEnumerationsTable&lt;/b&gt;() &amp;rarr; &lt;q ref=&quot;core.lib:Global!ENUM_OBJ&quot;&gt;ENUM_OBJ&lt;/q&gt;[id]"></Parameters><Return type="lib:Global!ENUM_OBJ[id]" typeRef="&lt;q ref=&quot;core.lib:Global!ENUM_OBJ&quot;&gt;ENUM_OBJ&lt;/q&gt;[id]">Table of enumeration objects, indexed by enumeration id.</Return><Remarks>Enumeration id's are stored in uppercase. Use &lt;q ref=&quot;core.lib:Basic!UPPER&quot;&gt;UPPER&lt;/q&gt; macro to convert the enumeration's id to uppercase
before using it as the index in this table.</Remarks></Method>
<Method name="removeEnumeration" sortGroup="true" scope="public" id="core.env:KitEnumerations!removeEnumeration" sort="35" group="Methods" seq="0003"><Summary>Removes a specified enumeration.</Summary><Parameters signature="method:: &lt;i&gt;$ENV&lt;/i&gt;.&lt;b&gt;removeEnumeration&lt;/b&gt;(&lt;i&gt;id&lt;/i&gt;) &amp;rarr; void"><Param name="id" type="QName">The id of the enumeration to remove.</Param></Parameters><Return></Return></Method>
</Topics>
</Interface>