<?xml version="1.0" encoding="Windows-1255" ?><Class name="GkbChannel" inherit="core.env:BaseChannel" id="core.env:GkbChannel" sort="21" urn="core.env:classes.GkbChannel.gs" toc="\Classes"><Summary>A channel that provides a connection to a Visual Composer server.</Summary><Inherit><q ref="core.env:BaseChannel">BaseChannel</q></Inherit><Remarks>Instances of this class are created automatically by the system, and should
not be created directly.</Remarks><Copyright>(c) SAP AG 2003-2006. All rights reserved.</Copyright>
<Topics>
<Method name="activationDetails" sortGroup="true" scope="public" id="core.env:GkbChannel!activationDetails" sort="35" group="Methods" seq="0000"><Summary>Get or refresh activation details.</Summary><Parameters signature="method:: <i>this</i>.<b>activationDetails</b>() &rarr; String"></Parameters><Return type="String">Returns the ID of the laetst activation.</Return></Method>
<Method name="addToDTR" sortGroup="true" scope="public" id="core.env:GkbChannel!addToDTR" sort="35" group="Methods" seq="0001"><Summary>Adds a local model to DTR.</Summary><Parameters signature="method:: <i>this</i>.<b>addToDTR</b>(<i>urn</i>, <i>softwareComp</i>, <i>develComp</i>, <i>activityDesc</i>, <i>dcDomain</i>) &rarr; Boolean"><Param name="urn" type="String">The urn of the local model.</Param><Param name="softwareComp" type="String">The software component of the development component.</Param><Param name="develComp" type="String">The development component to create.</Param><Param name="activityDesc" type="String">The Activity description.</Param><Param name="dcDomain" type="String">The domain of the model (SAPInternalValue).</Param></Parameters><Return type="Boolean">Returns the name of the added-to-DTR model if the operation was successfull; otherwise, returns <code>false</code></Return></Method>
<Method name="checkinModel" sortGroup="true" scope="public" id="core.env:GkbChannel!checkinModel" sort="35" group="Methods" seq="0002"><Summary>Checkes in to the DTR the given development component.</Summary><Parameters signature="method:: <i>this</i>.<b>checkinModel</b>(<i>urn</i>) &rarr; object"><Param name="urn" type="String">The urn of the development component to check-in.</Param></Parameters><Return type="object">Returns a map with the name and activation-status of the checked-in model if the operation was successfull; otherwise, returns <code>false</code></Return></Method>
<Method name="checkoutModel" sortGroup="true" scope="public" id="core.env:GkbChannel!checkoutModel" sort="35" group="Methods" seq="0003"><Summary>Checkes out the given development component.</Summary><Parameters signature="method:: <i>this</i>.<b>checkoutModel</b>(<i>urn</i>, <i>activityDesc</i>) &rarr; Boolean"><Param name="urn" type="String">The urn of the development component to checkout.</Param><Param name="activityDesc" type="String">The Activity description of the check-out.</Param></Parameters><Return type="Boolean">Returns <code>true</code> if the operation was successfull; otherwise, returns <code>false</code></Return></Method>
<Method name="copyFolder" sortGroup="true" scope="public" id="core.env:GkbChannel!copyFolder" sort="35" group="Methods" seq="0004"><Summary>Copies an existing folder/model to another location.</Summary><Parameters signature="method:: <i>this</i>.<b>copyFolder</b>(<i>from</i>, <i>to</i>) &rarr; Boolean"><Param name="from" type="String">The urn of the folder/model to copy from.</Param><Param name="to" type="String">The urn of the folder/model to copy to.</Param></Parameters><Return type="Boolean">Returns <code>true</code> if the operation was successfull; otherwise, returns <code>false</code></Return></Method>
<Method name="copyToDTR" sortGroup="true" scope="public" id="core.env:GkbChannel!copyToDTR" sort="35" group="Methods" seq="0005"><Summary>Overrides the content of the given DC (target) with the given local model.</Summary><Parameters signature="method:: <i>this</i>.<b>copyToDTR</b>(<i>source</i>, <i>target</i>) &rarr; Boolean"><Param name="source" type="String">The urn of the local model.</Param><Param name="target" type="String">The urn of the development component.</Param></Parameters><Return type="Boolean">Returns <code>true</code> if the operation was successfull; otherwise, returns <code>false</code></Return></Method>
<Method name="copyToLocal" sortGroup="true" scope="public" id="core.env:GkbChannel!copyToLocal" sort="35" group="Methods" seq="0006"><Summary>Copies the given DC to the given destination.</Summary><Parameters signature="method:: <i>this</i>.<b>copyToLocal</b>(<i>urn</i>, <i>destination</i>) &rarr; Boolean"><Param name="urn" type="String">The urn of the development component.</Param><Param name="destination" type="String">Destination path to copy to.</Param></Parameters><Return type="Boolean">Returns <code>true</code> if the operation was successfull; otherwise, returns <code>false</code></Return></Method>
<Method name="createFolder" sortGroup="true" scope="public" id="core.env:GkbChannel!createFolder" sort="35" group="Methods" seq="0007"><Summary>Creates a new folder/model.</Summary><Parameters signature="method:: <i>this</i>.<b>createFolder</b>(<i>urn</i>, <i>isSrcCtrlEnabled</i>) &rarr; Boolean"><Param name="urn" type="String">The urn of the new folder/model.</Param><Param name="isSrcCtrlEnabled" type="Boolean">Indicates whether the model should be saved in the source control.</Param></Parameters><Return type="Boolean">Returns <code>true</code> if the operation was successfull; otherwise, returns <code>false</code></Return></Method>
<Method name="fetchFiles" sortGroup="true" scope="public" id="core.env:GkbChannel!fetchFiles" sort="35" group="Methods" seq="0008"><Summary>Fetches a specified list of files after preprocessing.</Summary><Parameters signature="method:: <i>this</i>.<b>fetchFiles</b>(<i>urnlist</i>) &rarr; Object[]"><Param name="urnlist" type="String[]">A list of file urns to fetch.</Param></Parameters><Return type="Object[]">Returns an array of {urn, text} objects containing the fetched files in order.</Return><Remarks>Use the <q ref="core.env:BaseChannel!error">error</q> property to check for any errors.</Remarks></Method>
<Method name="fetchKit" sortGroup="true" scope="public" id="core.env:GkbChannel!fetchKit" sort="35" group="Methods" seq="0009"><Summary>Fetches a specified kit and returns all its files after preprocessing.</Summary><Parameters signature="method:: <i>this</i>.<b>fetchKit</b>(<i>urn</i>) &rarr; Object[]"><Param name="urn" type="String">The urn of the kit to fetch.</Param></Parameters><Return type="Object[]">Returns an array of {urn, text} objects containing the kit files in loading order.</Return><Remarks>Use the <q ref="core.env:BaseChannel!error">error</q> property to check for any errors.</Remarks></Method>
<Method name="getCheckoutDetails" sortGroup="true" scope="public" id="core.env:GkbChannel!getCheckoutDetails" sort="35" group="Methods" seq="0010"><Summary>Returns checkout details of the given model. Call this function in case that the model is checked out in another server (not current) by this user.</Summary><Parameters signature="method:: <i>this</i>.<b>getCheckoutDetails</b>(<i>urn</i>) &rarr; String"><Param name="urn" type="String">The urn of the development component to get its details.</Param></Parameters><Return type="String">Returns checkout details.</Return></Method>
<Method name="getClassHierarchy" sortGroup="true" scope="public" id="core.env:GkbChannel!getClassHierarchy" sort="35" group="Methods" seq="0011"><Summary>Gets the hierarchy of the given GML class
Returns an array of predecessors.</Summary><Parameters signature="method:: <i>this</i>.<b>getClassHierarchy</b>(<i>fullClassname</i>) &rarr; object"><Param name="fullClassname" type="String">Full GML class name.</Param></Parameters><Return type="object">Returns an array of predecessors of the given GML class.</Return></Method>
<Method name="getClassMetadata" sortGroup="true" scope="public" id="core.env:GkbChannel!getClassMetadata" sort="35" group="Methods" seq="0012"><Summary>Gets the metadata of the given GML class
The metadata is returned in a map of pairs: (metadata-name, metadata-value).</Summary><Parameters signature="method:: <i>this</i>.<b>getClassMetadata</b>(<i>fullClassname</i>, <i>includeInherited</i>) &rarr; object"><Param name="fullClassname" type="String">Full GML class name.</Param><Param name="includeInherited" type="Boolean" default="true">Indicates whether to include inherited metadata.</Param></Parameters><Return type="object">Returns the metadata of the given GML class.</Return></Method>
<Method name="getClassProps" sortGroup="true" scope="public" id="core.env:GkbChannel!getClassProps" sort="35" group="Methods" seq="0013"><Summary>Gets the properties of the given GML class
The properties are returned in a map of pairs:(property, property-attribute)
while property-attribute is a map of pairs: (attributeName, attributeValue).</Summary><Parameters signature="method:: <i>this</i>.<b>getClassProps</b>(<i>fullClassname</i>, <i>includeInherited</i>) &rarr; object"><Param name="fullClassname" type="String">Full GML class name.</Param><Param name="includeInherited" type="Boolean" default="true">Indicates whether to include inherited properties.</Param></Parameters><Return type="object">Returns the properties of the given GML class.</Return></Method>
<Method name="getDCDetails" sortGroup="true" scope="public" id="core.env:GkbChannel!getDCDetails" sort="35" group="Methods" seq="0014"><Summary>Get the details of the given development component.</Summary><Parameters signature="method:: <i>this</i>.<b>getDCDetails</b>(<i>urn</i>) &rarr; Boolean"><Param name="urn" type="String">The urn of the development component to get its details.</Param></Parameters><Return type="Boolean">Returns <code>true</code> if the operation was successfull; otherwise, returns <code>false</code></Return></Method>
<Method name="getKitsManifest" sortGroup="true" scope="public" id="core.env:GkbChannel!getKitsManifest" sort="35" group="Methods" seq="0015"><Summary>Returns the manifest object.</Summary><Parameters signature="method:: <i>this</i>.<b>getKitsManifest</b>() &rarr; <q ref="core.env:KitsManifest">KitsManifest</q>"></Parameters><Return type="KitsManifest!" typeRef="<q ref="core.env:KitsManifest">KitsManifest</q>">The requested kits manifest object.</Return></Method>
<Method name="getKitsManifestXML" sortGroup="true" scope="public" id="core.env:GkbChannel!getKitsManifestXML" sort="35" group="Methods" seq="0016"><Summary>Gets the manifest of all kits installed on the library.</Summary><Parameters signature="method:: <i>this</i>.<b>getKitsManifestXML</b>() &rarr; KitsManifest XML object"></Parameters><Return type="KitsManifest XML object">The requested kits manifest XML.</Return></Method>
<Method name="getLatestActivation" sortGroup="true" scope="public" id="core.env:GkbChannel!getLatestActivation" sort="35" group="Methods" seq="0017"><Summary>Get the ID of the latest activation listed in the user workspace.</Summary><Parameters signature="method:: <i>this</i>.<b>getLatestActivation</b>() &rarr; String"></Parameters><Return type="String">Returns the ID of the laetst activation.</Return></Method>
<Method name="getSdkContents" sortGroup="true" scope="public" id="core.env:GkbChannel!getSdkContents" sort="35" group="Methods" seq="0018"><Summary>Gets the sdk documentation contents for this library.</Summary><Parameters signature="method:: <i>this</i>.<b>getSdkContents</b>() &rarr; XmlDocument"></Parameters><Return type="XmlDocument">The requested sdk contents.</Return></Method>
<Method name="getSupportInfo" sortGroup="true" scope="public" id="core.env:GkbChannel!getSupportInfo" sort="35" group="Methods" seq="0019"><Summary>Retrive from dev server the support info.</Summary><Parameters signature="method:: <i>this</i>.<b>getSupportInfo</b>(<i>applicationURL</i>) &rarr; object"><Param name="applicationURL" type="String">The runtime url of the VC application.</Param></Parameters><Return type="object"></Return></Method>
<Method name="getUserData" sortGroup="true" scope="public" id="core.env:GkbChannel!getUserData" sort="35" group="Methods" seq="0020"><Summary>Gets the user data map.</Summary><Parameters signature="method:: <i>this</i>.<b>getUserData</b>(<i>force</i>) &rarr; Object"><Param name="force" type="Boolean">Indicates whether the userdata should be retrieved
from the server, even if it was already retrieved.</Param></Parameters><Return type="Object">Returns a map of {key, value} containing the user-data.</Return></Method>
<Method name="listDomains" sortGroup="true" scope="public" id="core.env:GkbChannel!listDomains" sort="35" group="Methods" seq="0021"><Summary>Enumerates all the domains.</Summary><Parameters signature="method:: <i>this</i>.<b>listDomains</b>(<i>refresh</i>) &rarr; String"><Param name="refresh" type="Boolean">Indicates whether to retrieve information from NWDI server (true) or from cache (false) default=true.</Param></Parameters><Return type="String">Returns an enumeration of the domains.</Return></Method>
<Method name="listDTRDetails" sortGroup="true" scope="public" id="core.env:GkbChannel!listDTRDetails" sort="35" group="Methods" seq="0022"><Summary>Enumerates all the dtr details.</Summary><Parameters signature="method:: <i>this</i>.<b>listDTRDetails</b>(<i>refresh</i>) &rarr; String"><Param name="refresh" type="Boolean">Indicates whether to retrieve information from NWDI server (true) or from cache (false) default=true.</Param></Parameters><Return type="String">Returns an enumeration of the dtr details.</Return></Method>
<Method name="listFolders" sortGroup="true" scope="public" id="core.env:GkbChannel!listFolders" sort="35" group="Methods" seq="0023"><Summary>Enumerates all sub-folders/models under a specified folder.</Summary><Parameters signature="method:: <i>this</i>.<b>listFolders</b>(<i>parent</i>, <i>scope</i>, <i>refresh</i>) &rarr; {name,type,urn}[]"><Param name="parent" type="String">The urn of the parent folder.</Param><Param name="scope" default="MODELS|FOLDERS|ALL" type="String">The type of items to enumerate.</Param><Param name="refresh" type="Boolean">Indicates whether to retrieve information from NWDI server (true) or from cache (false) default=true.</Param></Parameters><Return type="{name,type,urn}[]">Returns a sorted enumeration of the requested items.</Return></Method>
<Method name="listPrefixes" sortGroup="true" scope="public" id="core.env:GkbChannel!listPrefixes" sort="35" group="Methods" seq="0024"><Summary>Enumerates all the prefixes which correspond to the given vendor.</Summary><Parameters signature="method:: <i>this</i>.<b>listPrefixes</b>(<i>vendor</i>, <i>refresh</i>) &rarr; String"><Param name="vendor" type="String">The vendor whose prefixes we wish to enumerate.</Param><Param name="refresh" type="Boolean">Indicates whether to retrieve information from NWDI server (true) or from cache (false) default=true.</Param></Parameters><Return type="String">Returns an enumeration of the prefixes.</Return></Method>
<Method name="listUnits" sortGroup="true" scope="public" id="core.env:GkbChannel!listUnits" sort="35" group="Methods" seq="0025"><Summary>Enumerates all units under a specified model.</Summary><Parameters signature="method:: <i>this</i>.<b>listUnits</b>(<i>urn</i>) &rarr; String[]"><Param name="urn" type="String">The urn of the model to enumerate.</Param></Parameters><Return type="String[]">Returns a sorted enumeration of the unit Ids.</Return></Method>
<Method name="listVendors" sortGroup="true" scope="public" id="core.env:GkbChannel!listVendors" sort="35" group="Methods" seq="0026"><Summary>Enumerates all the vendors.</Summary><Parameters signature="method:: <i>this</i>.<b>listVendors</b>(<i>refresh</i>) &rarr; String"><Param name="refresh" type="Boolean">Indicates whether to retrieve information from NWDI server (true) or from cache (false) default=true.</Param></Parameters><Return type="String">Returns an enumeration of the vendors.</Return></Method>
<Method name="moveFolder" sortGroup="true" scope="public" id="core.env:GkbChannel!moveFolder" sort="35" group="Methods" seq="0027"><Summary>Moves an existing folder/model to another location.</Summary><Parameters signature="method:: <i>this</i>.<b>moveFolder</b>(<i>from</i>, <i>to</i>) &rarr; Boolean"><Param name="from" type="String">The urn of the folder/model to move from.</Param><Param name="to" type="String">The urn of the folder/model to move to.</Param></Parameters><Return type="Boolean">Returns <code>true</code> if the operation was successfull; otherwise, returns <code>false</code></Return></Method>
<Method name="readFile" sortGroup="true" scope="public" id="core.env:GkbChannel!readFile" sort="35" group="Methods" seq="0028"><Summary>Reads a specified file.</Summary><Parameters signature="method:: <i>this</i>.<b>readFile</b>(<i>urn</i>, <i>asXML</i>) &rarr; String"><Param name="urn" type="String">The urn of the file to read.</Param><Param name="asXML" type="Boolean" default="false">Indicates whether to return XML files as an XML object.</Param></Parameters><Return type="String">Returns the file text.</Return><Remarks>Use the <q ref="core.env:BaseChannel!error">error</q> property to check for any errors.</Remarks></Method>
<Method name="readFiles" sortGroup="true" scope="public" id="core.env:GkbChannel!readFiles" sort="35" group="Methods" seq="0029"><Summary>Reads a specified list of files.</Summary><Parameters signature="method:: <i>this</i>.<b>readFiles</b>(<i>urnlist</i>, <i>asXML</i>) &rarr; String[urn]"><Param name="urnlist" type="String[]">A list of file urns to read.</Param><Param name="asXML" type="Boolean" default="false">Indicates whether to return XML files as an XML object.</Param></Parameters><Return type="String[urn]">Returns the list of files read, in corresponding order to the input urnlist.</Return><Remarks>Use the <q ref="core.env:BaseChannel!error">error</q> property to check for any errors.</Remarks></Method>
<Method name="removeFolder" sortGroup="true" scope="public" id="core.env:GkbChannel!removeFolder" sort="35" group="Methods" seq="0030"><Summary>Removes an existing folder/model.</Summary><Parameters signature="method:: <i>this</i>.<b>removeFolder</b>(<i>urn</i>) &rarr; Boolean"><Param name="urn" type="String">The urn of the folder/model to remove.</Param></Parameters><Return type="Boolean">Returns <code>true</code> if the operation was successfull; otherwise, returns <code>false</code></Return></Method>
<Method name="removeFromMonitorList" sortGroup="true" scope="public" id="core.env:GkbChannel!removeFromMonitorList" sort="35" group="Methods" seq="0031"><Summary>Get activation details.</Summary><Parameters signature="method:: <i>this</i>.<b>removeFromMonitorList</b>() &rarr; Boolean"></Parameters><Return type="Boolean">Returns whether the operation ended successfully (no exception) or not).</Return></Method>
<Method name="resetUserData" sortGroup="true" scope="public" id="core.env:GkbChannel!resetUserData" sort="35" group="Methods" seq="0032"><Summary>Resets the user-data.</Summary><Parameters signature="method:: <i>this</i>.<b>resetUserData</b>() &rarr; XmlDocument"></Parameters><Return type="XmlDocument">The reponse of the reset operation.</Return></Method>
<Method name="revertChanges" sortGroup="true" scope="public" id="core.env:GkbChannel!revertChanges" sort="35" group="Methods" seq="0033"><Summary>Reverts any changes done to the development component.</Summary><Parameters signature="method:: <i>this</i>.<b>revertChanges</b>(<i>urn</i>, <i>isNewRepositoryMdl</i>) &rarr; Boolean"><Param name="urn" type="String">The urn of the development component to revert.</Param><Param name="isNewRepositoryMdl" type="Boolean">Indicates whether the model to revert is new repository model.</Param></Parameters><Return type="Boolean">Returns the name of the model after revert if the operation was successfull; otherwise, returns <code>false</code></Return></Method>
<Method name="saveUserData" sortGroup="true" scope="public" id="core.env:GkbChannel!saveUserData" sort="35" group="Methods" seq="0034"><Summary>Saves the given user-data.</Summary><Parameters signature="method:: <i>this</i>.<b>saveUserData</b>(<i>xmlValues</i>) &rarr; XmlDocument"><Param name="xmlValues" type="x">Object containing name-value pairs for all parameters to be persisted.</Param></Parameters><Return type="XmlDocument">The response of the save operation.</Return></Method>
<Method name="searchUnits" sortGroup="true" scope="public" id="core.env:GkbChannel!searchUnits" sort="35" group="Methods" seq="0035"><Summary>Searches for the units that meet the specified criteria in a given model.</Summary><Parameters signature="method:: <i>this</i>.<b>searchUnits</b>(<i>urn</i>) &rarr; {id,name,type}[]"><Param name="urn" type="String">The urn of the model to search.</Param></Parameters><Return type="{id,name,type}[]">Returns the list of units that were found.</Return></Method>
<Method name="syncModel" sortGroup="true" scope="public" id="core.env:GkbChannel!syncModel" sort="35" group="Methods" seq="0036"><Summary>Syncs a model (the model's files will be in READONLY mode).</Summary><Parameters signature="method:: <i>this</i>.<b>syncModel</b>(<i>urn</i>, <i>force</i>) &rarr; Boolean"><Param name="urn" type="String">The urn of the development component to sync.</Param><Param name="force" type="Boolean" default="true">Indicates whether to force a sync.</Param></Parameters><Return type="Boolean">Returns <code>true</code> if the operation was successfull; otherwise, returns <code>false</code></Return></Method>
<Method name="syncToVersion" sortGroup="true" scope="public" id="core.env:GkbChannel!syncToVersion" sort="35" group="Methods" seq="0037"><Summary>Get the details of the given development component.</Summary><Parameters signature="method:: <i>this</i>.<b>syncToVersion</b>(<i>urn</i>, <i>revision</i>) &rarr; Boolean"><Param name="urn" type="String">The urn of the development component.</Param><Param name="revision" type="String">The number of revision to sync to.</Param></Parameters><Return type="Boolean">Returns <code>true</code> if the operation was successfull; otherwise, returns <code>false</code></Return></Method>
<Method name="toModelFile" sortGroup="true" scope="public" id="core.env:GkbChannel!toModelFile" sort="35" group="Methods" seq="0038"><Summary>Converts a bare file name to a full file urn for a given model.</Summary><Parameters signature="method:: <i>this</i>.<b>toModelFile</b>(<i>modelUrn</i>, <i>filename</i>) &rarr; String"><Param name="modelUrn" type="String">The model urn.</Param><Param name="filename" type="String">The file name.</Param></Parameters><Return type="String">Returns the full file urn.</Return></Method>
<Method name="toModelHandle" sortGroup="true" scope="public" id="core.env:GkbChannel!toModelHandle" sort="35" group="Methods" seq="0039"><Summary>Converts the given model urn to a model handle, using the channel connection details.</Summary><Parameters signature="method:: <i>this</i>.<b>toModelHandle</b>(<i>modelUrn</i>, <i>modelStatus</i>) &rarr; <q ref="core.env:ModelInfo">ModelInfo</q>"><Param name="modelUrn" type="String">The model urn.</Param><Param name="modelStatus" type="String">The model's status.</Param></Parameters><Return type="ModelInfo!" typeRef="<q ref="core.env:ModelInfo">ModelInfo</q>">The requested model handle.</Return></Method>
<Method name="writeFile" sortGroup="true" scope="public" id="core.env:GkbChannel!writeFile" sort="35" group="Methods" seq="0040"><Summary>Writes a specified file.</Summary><Parameters signature="method:: <i>this</i>.<b>writeFile</b>(<i>urn</i>, <i>text</i>) &rarr; Boolean"><Param name="urn" type="String">The file urn.</Param><Param name="text" type="String">The file text.</Param></Parameters><Return type="Boolean">Returns <code>true</code> if the operation was successfull; otherwise, returns <code>false</code></Return><Remarks>Use the <q ref="core.env:BaseChannel!error">error</q> property to check for any errors.</Remarks></Method>
<Method name="writeFiles" sortGroup="true" scope="public" id="core.env:GkbChannel!writeFiles" sort="35" group="Methods" seq="0041"><Summary>Writes a specified list of files.</Summary><Parameters signature="method:: <i>this</i>.<b>writeFiles</b>(<i>list</i>) &rarr; Boolean"><Param name="list" type="String[urn]">A table of the files to write.</Param></Parameters><Return type="Boolean">Returns <code>true</code> if the operation was successfull; otherwise, returns <code>false</code></Return><Remarks>Use the <q ref="core.env:BaseChannel!error">error</q> property to check for any errors.</Remarks></Method>
</Topics>
</Class>