<?xml version="1.0" encoding="Windows-1255" ?><Class name="SearchConnector" inherit="core.gml:Object" id="core.dev:SearchConnector" sort="21" urn="core.dev:search.SearchConnector.gs" toc="\Unified Search"><Summary>Class provides some methods to retrieve the metadata of BusinessObjects.</Summary><Inherit>&lt;q ref=&quot;core.gml:Object&quot;&gt;Object&lt;/q&gt;</Inherit>
<Topics>
<Method name="cancel" sortGroup="true" scope="public" id="core.dev:SearchConnector!cancel" sort="35" group="Methods" seq="0000"><Summary>cancel the search operation.</Summary><Parameters signature="method:: &lt;i&gt;this&lt;/i&gt;.&lt;b&gt;cancel&lt;/b&gt;() &amp;rarr; void"></Parameters><Return></Return></Method>
<Method name="getAdditionalParamsEditor" sortGroup="true" scope="public" id="core.dev:SearchConnector!getAdditionalParamsEditor" sort="35" group="Methods" seq="0001"><Summary>get the additional parameters for the search.</Summary><Parameters signature="method:: &lt;i&gt;this&lt;/i&gt;.&lt;b&gt;getAdditionalParamsEditor&lt;/b&gt;(&lt;i&gt;provider&lt;/i&gt;, &lt;i&gt;objectType&lt;/i&gt;) &amp;rarr; object"><Param name="provider" type="string">the selected provider.</Param><Param name="objectType" type="string">the selected object type.</Param></Parameters><Return type="object">object with the additional parameters.</Return></Method>
<Method name="getBrowseContextMenu" sortGroup="true" scope="public" id="core.dev:SearchConnector!getBrowseContextMenu" sort="35" group="Methods" seq="0002"><Summary>get the browse context menu for specific node id.</Summary><Parameters signature="method:: &lt;i&gt;this&lt;/i&gt;.&lt;b&gt;getBrowseContextMenu&lt;/b&gt;(&lt;i&gt;provider&lt;/i&gt;, &lt;i&gt;id&lt;/i&gt;, &lt;i&gt;system&lt;/i&gt;, &lt;i&gt;objectType&lt;/i&gt;) &amp;rarr; object"><Param name="provider" type="string">the selected provider.</Param><Param name="id" type="string">the node's id.</Param><Param name="system" type="string">the node's system.</Param><Param name="objectType" type="string">the selected object type.</Param></Parameters><Return type="object">object with the context menu.</Return></Method>
<Method name="getBrowseProviders" sortGroup="true" scope="public" id="core.dev:SearchConnector!getBrowseProviders" sort="35" group="Methods" seq="0003"><Summary>Get all the browse providers which are related to the model.</Summary><Parameters signature="method:: &lt;i&gt;this&lt;/i&gt;.&lt;b&gt;getBrowseProviders&lt;/b&gt;(&lt;i&gt;productionKit&lt;/i&gt;) &amp;rarr; object"><Param name="productionKit" type="string">the production kit in the model.</Param></Parameters><Return type="object">list of provider nodes.</Return></Method>
<Method name="getChildNodes" sortGroup="true" scope="public" id="core.dev:SearchConnector!getChildNodes" sort="35" group="Methods" seq="0004"><Summary>get all the child nodes of the gived node.</Summary><Parameters signature="method:: &lt;i&gt;this&lt;/i&gt;.&lt;b&gt;getChildNodes&lt;/b&gt;(&lt;i&gt;provider&lt;/i&gt;, &lt;i&gt;id&lt;/i&gt;, &lt;i&gt;parentNode&lt;/i&gt;) &amp;rarr; object"><Param name="provider" type="string">the selected provider.</Param><Param name="id" type="string">the node's id.</Param><Param name="parentNode" type="object">the node.</Param></Parameters><Return type="object">list of child nodes.</Return></Method>
<Method name="getDetailsForItem" sortGroup="true" scope="public" id="core.dev:SearchConnector!getDetailsForItem" sort="35" group="Methods" seq="0005"><Summary>get all the details on the selected result - infoshapes, ports etc.
   returns in the format of the standard xml.</Summary><Parameters signature="method:: &lt;i&gt;this&lt;/i&gt;.&lt;b&gt;getDetailsForItem&lt;/b&gt;(&lt;i&gt;provider&lt;/i&gt;, &lt;i&gt;id&lt;/i&gt;, &lt;i&gt;name&lt;/i&gt;, &lt;i&gt;system&lt;/i&gt;, &lt;i&gt;objectType&lt;/i&gt;) &amp;rarr; string"><Param name="provider" type="string">the selected provider.</Param><Param name="id" type="string">the id of the selected result.</Param><Param name="name" type="string">the name of the selected result.</Param><Param name="system" type="string">the system.</Param><Param name="objectType" type="string">the object type.</Param></Parameters><Return type="string">the details in the standard xml format.</Return></Method>
<Method name="getIconFromVCNode" sortGroup="true" scope="public" id="core.dev:SearchConnector!getIconFromVCNode" sort="35" group="Methods" seq="0006"><Summary>return the icon for the VC node.</Summary><Parameters signature="method:: &lt;i&gt;this&lt;/i&gt;.&lt;b&gt;getIconFromVCNode&lt;/b&gt;(&lt;i&gt;item&lt;/i&gt;) &amp;rarr; string"><Param name="item" type="object">the VC node to extract the icon from.</Param></Parameters><Return type="string">the icon string.</Return></Method>
<Method name="getNextResults" sortGroup="true" scope="public" id="core.dev:SearchConnector!getNextResults" sort="35" group="Methods" seq="0007"><Summary>get the next results page of the provider, if it support paging.</Summary><Parameters signature="method:: &lt;i&gt;this&lt;/i&gt;.&lt;b&gt;getNextResults&lt;/b&gt;(&lt;i&gt;next&lt;/i&gt;, &lt;i&gt;provider&lt;/i&gt;, &lt;i&gt;lastRec&lt;/i&gt;, &lt;i&gt;pageSize&lt;/i&gt;) &amp;rarr; object"><Param name="next" type="boolean">true for next results and false for previous results.</Param><Param name="provider" type="string">the selected provider.</Param><Param name="lastRec" type="number">the last record shown already.</Param><Param name="pageSize" type="number">the page size.</Param></Parameters><Return type="object">object with the search results.</Return></Method>
<Method name="getNode" sortGroup="true" scope="public" id="core.dev:SearchConnector!getNode" sort="35" group="Methods" seq="0008"><Summary>get specific node according to its id.</Summary><Parameters signature="method:: &lt;i&gt;this&lt;/i&gt;.&lt;b&gt;getNode&lt;/b&gt;(&lt;i&gt;provider&lt;/i&gt;, &lt;i&gt;id&lt;/i&gt;) &amp;rarr; object"><Param name="provider" type="string">the selected provider.</Param><Param name="id" type="string">the node's id.</Param></Parameters><Return type="object">node.</Return></Method>
<Method name="getNodePath" sortGroup="true" scope="public" id="core.dev:SearchConnector!getNodePath" sort="35" group="Methods" seq="0009"><Summary>Returns the ancestors path leading to and including the specified node.</Summary><Parameters signature="method:: &lt;i&gt;this&lt;/i&gt;.&lt;b&gt;getNodePath&lt;/b&gt;(&lt;i&gt;provider&lt;/i&gt;, &lt;i&gt;id&lt;/i&gt;) &amp;rarr; Array"><Param name="provider" type="string">the selected provider.</Param><Param name="id" type="string">the node's id.</Param></Parameters><Return type="Array">Array of ids ehich is the path leading to the node.</Return></Method>
<Method name="getObjectTypes" sortGroup="true" scope="public" id="core.dev:SearchConnector!getObjectTypes" sort="35" group="Methods" seq="0010"><Summary>get the object types of the selected provider.</Summary><Parameters signature="method:: &lt;i&gt;this&lt;/i&gt;.&lt;b&gt;getObjectTypes&lt;/b&gt;(&lt;i&gt;provider&lt;/i&gt;) &amp;rarr; object"><Param name="provider" type="string">the selected provider.</Param></Parameters><Return type="object">the object key is the object type id and the value is the object type name.</Return></Method>
<Method name="getQuickDetailsOnDemand" sortGroup="true" scope="public" id="core.dev:SearchConnector!getQuickDetailsOnDemand" sort="35" group="Methods" seq="0011"><Summary>get more details on the result. those details will be displayed in the .htm opened from
   the &quot;show more&quot; link in the additional information view.</Summary><Parameters signature="method:: &lt;i&gt;this&lt;/i&gt;.&lt;b&gt;getQuickDetailsOnDemand&lt;/b&gt;(&lt;i&gt;provider&lt;/i&gt;, &lt;i&gt;id&lt;/i&gt;, &lt;i&gt;name&lt;/i&gt;, &lt;i&gt;system&lt;/i&gt;, &lt;i&gt;objectType&lt;/i&gt;) &amp;rarr; string"><Param name="provider" type="string">the selected provider.</Param><Param name="id" type="string">the id of the selected result.</Param><Param name="name" type="string">the name of the selected result.</Param><Param name="system" type="string">the system.</Param><Param name="objectType" type="string">the object type.</Param></Parameters><Return type="string">the details.</Return></Method>
<Method name="getRelatedBrowseProvider" sortGroup="true" scope="public" id="core.dev:SearchConnector!getRelatedBrowseProvider" sort="35" group="Methods" seq="0012"><Summary>get the related browse provider for the locate in tree operation.</Summary><Parameters signature="method:: &lt;i&gt;this&lt;/i&gt;.&lt;b&gt;getRelatedBrowseProvider&lt;/b&gt;(&lt;i&gt;provider&lt;/i&gt;) &amp;rarr; string"><Param name="provider" type="string">the selected provider.</Param></Parameters><Return type="string">the related provider.</Return></Method>
<Method name="getSearchContextMenu" sortGroup="true" scope="public" id="core.dev:SearchConnector!getSearchContextMenu" sort="35" group="Methods" seq="0013"><Summary>get the search context menu for specific object type.</Summary><Parameters signature="method:: &lt;i&gt;this&lt;/i&gt;.&lt;b&gt;getSearchContextMenu&lt;/b&gt;(&lt;i&gt;provider&lt;/i&gt;, &lt;i&gt;objectType&lt;/i&gt;) &amp;rarr; object"><Param name="provider" type="string">the selected provider.</Param><Param name="objectType" type="string">the selected object type.</Param></Parameters><Return type="object">object with the context menu.</Return></Method>
<Method name="getSearchProviders" sortGroup="true" scope="public" id="core.dev:SearchConnector!getSearchProviders" sort="35" group="Methods" seq="0014"><Summary>Get all the search providers which are related to the model.</Summary><Parameters signature="method:: &lt;i&gt;this&lt;/i&gt;.&lt;b&gt;getSearchProviders&lt;/b&gt;(&lt;i&gt;productionKit&lt;/i&gt;) &amp;rarr; object"><Param name="productionKit" type="string">the production kit in the model.</Param></Parameters><Return type="object">the object key is the provider name and the value is the deisplayed name.</Return></Method>
<Method name="localGetDetailsForItem" sortGroup="true" scope="public" id="core.dev:SearchConnector!localGetDetailsForItem" sort="35" group="Methods" seq="0015"><Summary>get more details on a local selected result.</Summary><Parameters signature="method:: &lt;i&gt;this&lt;/i&gt;.&lt;b&gt;localGetDetailsForItem&lt;/b&gt;(&lt;i&gt;name&lt;/i&gt;) &amp;rarr; void"><Param name="name" type="string">the name of the selected result.</Param></Parameters><Return></Return></Method>
<Method name="localSearch" sortGroup="true" scope="public" id="core.dev:SearchConnector!localSearch" sort="35" group="Methods" seq="0016"><Summary>execute a local search operation.</Summary><Parameters signature="method:: &lt;i&gt;this&lt;/i&gt;.&lt;b&gt;localSearch&lt;/b&gt;(&lt;i&gt;searchParams&lt;/i&gt;) &amp;rarr; void"><Param name="searchParams" type="object">key:value object with parameters for the search.</Param></Parameters><Return></Return></Method>
<Method name="search" sortGroup="true" scope="public" id="core.dev:SearchConnector!search" sort="35" group="Methods" seq="0017"><Summary>execute the search operation. this is an asynchronous operation. when it finished, it execute the function
   parseResults, which parse the results and pass them to the search element.</Summary><Parameters signature="method:: &lt;i&gt;this&lt;/i&gt;.&lt;b&gt;search&lt;/b&gt;(&lt;i&gt;searchParams&lt;/i&gt;, &lt;i&gt;provider&lt;/i&gt;, &lt;i&gt;pageSize&lt;/i&gt;) &amp;rarr; void"><Param name="searchParams" type="object">key:value object with parameters for the search.</Param><Param name="provider" type="string">the selected provider.</Param><Param name="pageSize" type="number">page size if the provider support paging.</Param></Parameters><Return></Return></Method>
<Method name="supportPaging" sortGroup="true" scope="public" id="core.dev:SearchConnector!supportPaging" sort="35" group="Methods" seq="0018"><Summary>return true if the provider support paging.</Summary><Parameters signature="method:: &lt;i&gt;this&lt;/i&gt;.&lt;b&gt;supportPaging&lt;/b&gt;(&lt;i&gt;provider&lt;/i&gt;) &amp;rarr; boolean"><Param name="provider" type="string">the provider to check.</Param></Parameters><Return type="boolean"></Return></Method>
<Method name="supportsQuickDetailsOnDemand" sortGroup="true" scope="public" id="core.dev:SearchConnector!supportsQuickDetailsOnDemand" sort="35" group="Methods" seq="0019"><Summary>return true if the provider support get quick details on demand.</Summary><Parameters signature="method:: &lt;i&gt;this&lt;/i&gt;.&lt;b&gt;supportsQuickDetailsOnDemand&lt;/b&gt;(&lt;i&gt;provider&lt;/i&gt;, &lt;i&gt;system&lt;/i&gt;, &lt;i&gt;objectType&lt;/i&gt;) &amp;rarr; boolean"><Param name="provider" type="string">the provider to check.</Param><Param name="system" type="string">the system.</Param><Param name="objectType" type="string">the object type.</Param></Parameters><Return type="boolean"></Return></Method>
<Event name="onBrowseDrop" sortGroup="true" scope="public" id="core.dev:SearchConnector!onBrowseDrop" sort="36" group="Events" seq="0020"><Summary>Fires when dropping tree node item.</Summary><Parameters signature="event:: &lt;b&gt;onBrowseDrop&lt;/b&gt; &amp;rarr; {&lt;i&gt;def&lt;/i&gt;, &lt;i&gt;connector&lt;/i&gt;, &lt;i&gt;provider&lt;/i&gt;, &lt;i&gt;objectType&lt;/i&gt;, &lt;i&gt;id&lt;/i&gt;}"><Param name="def" type="object">the smartform object.</Param><Param name="connector" type="string">id of the connector to the server.by calling its method getDetailsForItem it is
     possible to get the additional metadata needed.</Param><Param name="provider" type="string">the provider's name.</Param><Param name="objectType" type="string">the search object type.</Param><Param name="id" type="string">the element id.</Param></Parameters></Event>
<Event name="onLocateInTree" sortGroup="true" scope="public" id="core.dev:SearchConnector!onLocateInTree" sort="36" group="Events" seq="0021"><Summary>Fires when choosing the locate in tree option in the search results context menu.</Summary><Parameters signature="event:: &lt;b&gt;onLocateInTree&lt;/b&gt; &amp;rarr; {&lt;i&gt;provider&lt;/i&gt;, &lt;i&gt;id&lt;/i&gt;}"><Param name="provider" type="string">the provider's name.</Param><Param name="id" type="string">the search result id to locate.</Param></Parameters></Event>
<Event name="onSearchDrop" sortGroup="true" scope="public" id="core.dev:SearchConnector!onSearchDrop" sort="36" group="Events" seq="0022"><Summary>Fires when dropping search result item.</Summary><Parameters signature="event:: &lt;b&gt;onSearchDrop&lt;/b&gt; &amp;rarr; {&lt;i&gt;def&lt;/i&gt;, &lt;i&gt;connector&lt;/i&gt;, &lt;i&gt;provider&lt;/i&gt;, &lt;i&gt;objectType&lt;/i&gt;, &lt;i&gt;id&lt;/i&gt;}"><Param name="def" type="object">the smartform object.</Param><Param name="connector" type="string">id of the connector to the server.by calling its method getDetailsForItem it is
     possible to get the additional metadata needed.</Param><Param name="provider" type="string">the provider's name.</Param><Param name="objectType" type="string">the search object type.</Param><Param name="id" type="string">the element id.</Param></Parameters></Event>
<Event name="onSearchLoad" sortGroup="true" scope="public" id="core.dev:SearchConnector!onSearchLoad" sort="36" group="Events" seq="0023"><Summary>Fires when loading search from context menu.</Summary><Parameters signature="event:: &lt;b&gt;onSearchLoad&lt;/b&gt; &amp;rarr; {&lt;i&gt;provider&lt;/i&gt;, &lt;i&gt;objectType&lt;/i&gt;}"><Param name="provider" type="string">the provider's name.</Param><Param name="objectType" type="string">the search object type.</Param></Parameters></Event>
<Event name="onSearchLogin" sortGroup="true" scope="public" id="core.dev:SearchConnector!onSearchLogin" sort="36" group="Events" seq="0024"><Summary>Fires when choosing search or browse provider.</Summary><Parameters signature="event:: &lt;b&gt;onSearchLogin&lt;/b&gt; &amp;rarr; {&lt;i&gt;provider&lt;/i&gt;, &lt;i&gt;connector&lt;/i&gt;}"><Param name="provider" type="string">the provider's name.</Param><Param name="connector" type="string">id of the connector to the server.</Param></Parameters></Event>
</Topics>
</Class>