Sophie

Sophie

distrib > Fedora > 14 > x86_64 > media > updates > by-pkgid > 71d40963b505df4524269198e237b3e3 > files > 803

virtuoso-opensource-doc-6.1.4-2.fc14.noarch.rpm

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html>
 <head profile="http://internetalchemy.org/2003/02/profile">
  <link rel="foaf" type="application/rdf+xml" title="FOAF" href="http://www.openlinksw.com/dataspace/uda/about.rdf" />
  <link rel="schema.dc" href="http://purl.org/dc/elements/1.1/" />
  <meta name="dc.title" content="Function: uddi_find_service - Virtuoso Functions Guide" />
  <meta name="dc.subject" content="Function: uddi_find_service - Virtuoso Functions Guide" />
  <meta name="dc.creator" content="OpenLink Software Documentation Team ;&#10;" />
  <meta name="dc.copyright" content="OpenLink Software, 1999 - 2009" />
  <link rel="top" href="index.html" title="OpenLink Virtuoso Universal Server: Documentation" />
  <link rel="search" href="/doc/adv_search.vspx" title="Search OpenLink Virtuoso Universal Server: Documentation" />
  <link rel="parent" href="functions.html" title="Chapter Contents" />
  <link rel="prev" href="appendixa.html" title="Appendix" />
  <link rel="next" href="functions.html#.html" title="" />
  <link rel="shortcut icon" href="../images/misc/favicon.ico" type="image/x-icon" />
  <link rel="stylesheet" type="text/css" href="doc.css" />
  <link rel="stylesheet" type="text/css" href="/doc/translation.css" />
  <title>Function: uddi_find_service - Virtuoso Functions Guide</title>
  <meta http-equiv="Content-Type" content="text/xhtml; charset=UTF-8" />
  <meta name="author" content="OpenLink Software Documentation Team ;&#10;" />
  <meta name="copyright" content="OpenLink Software, 1999 - 2009" />
  <meta name="keywords" content="" />
  <meta name="GENERATOR" content="OpenLink XSLT Team" />
 </head>
 <body>
  <div id="header">
    <a name="me_uddi_find_service" />
    <img src="../images/misc/logo.jpg" alt="" />
    <h1>22. Virtuoso Functions Guide - uddi_find_service</h1>
  </div>
  <div id="navbartop">
   <div>
      <a class="link" href="functions.html">Chapter Contents</a> | <a class="link" href="me_uddi_find_business.html" title="uddi_find_business">Prev</a> | <a class="link" href="me_uddi_find_tModel.html" title="uddi_find_tModel">Next</a>
   </div>
  </div>
  <div id="currenttoc">
   <form method="post" action="/doc/adv_search.vspx">
    <div class="search">Keyword Search: <br />
        <input type="text" name="q" /> <input type="submit" name="go" value="Go" />
    </div>
   </form>
   <div>
      <a href="http://www.openlinksw.com/">www.openlinksw.com</a>
   </div>
   <div>
      <a href="http://docs.openlinksw.com/">docs.openlinksw.com</a>
   </div>
    <br />
   <div>
      <a href="index.html">Book Home</a>
   </div>
    <br />
   <div>
      <a href="contents.html">Contents</a>
   </div>
   <div>
      <a href="preface.html">Preface</a>
   </div>
    <br />
   <div>
      <a class="selected" href="functions.html">Virtuoso Functions Guide</a>
   </div>
    <br />
   <div>
      <a href="functions.html#admin">Administration</a>
   </div>
   <div>
      <a href="functions.html#aggr">Aggregate Functions</a>
   </div>
   <div>
      <a href="functions.html#array">Array Manipulation</a>
   </div>
   <div>
      <a href="functions.html#bpel">BPEL APIs</a>
   </div>
   <div>
      <a href="functions.html#backup">Backup</a>
   </div>
   <div>
      <a href="functions.html#compression">Compression</a>
   </div>
   <div>
      <a href="functions.html#cursors">Cursor</a>
   </div>
   <div>
      <a href="functions.html#time">Date &amp; Time Manipulation</a>
   </div>
   <div>
      <a href="functions.html#debug">Debug</a>
   </div>
   <div>
      <a href="functions.html#dict">Dictionary Manipulation</a>
   </div>
   <div>
      <a href="functions.html#encoding">Encoding &amp; Decoding</a>
   </div>
   <div>
      <a href="functions.html#file">File Manipulation</a>
   </div>
   <div>
      <a href="functions.html#ft">Free Text</a>
   </div>
   <div>
      <a href="functions.html#hash">Hashing / Cryptographic</a>
   </div>
   <div>
      <a href="functions.html#ldap">LDAP</a>
   </div>
   <div>
      <a href="functions.html#localization">Locale</a>
   </div>
   <div>
      <a href="functions.html#mail">Mail</a>
   </div>
   <div>
      <a href="functions.html#misc">Miscellaneous</a>
   </div>
   <div>
      <a href="functions.html#number">Number</a>
   </div>
   <div>
      <a href="functions.html#phrz">Phrases</a>
   </div>
   <div>
      <a href="functions.html#rdf">RDF data</a>
   </div>
   <div>
      <a href="functions.html#rmt">Remote SQL Data Source</a>
   </div>
   <div>
      <a href="functions.html#repl">Replication</a>
   </div>
   <div>
      <a href="functions.html#soap">SOAP</a>
   </div>
   <div>
      <a href="functions.html#sql">SQL</a>
   </div>
   <div>
      <a href="functions.html#string">String</a>
   </div>
   <div>
      <a href="functions.html#txn">Transaction</a>
   </div>
   <div>
      <a href="functions.html#type">Type Mapping</a>
   </div>
   <div>
      <a class="selected" href="functions.html#uddi">UDDI</a>
   </div>
   <div class="selected">
    <div>
        <a href="me_uddi_delete_binding.html">uddi_delete_binding</a>
    </div>
    <div>
        <a href="me_uddi_delete_business.html">uddi_delete_business</a>
    </div>
    <div>
        <a href="me_uddi_delete_service.html">uddi_delete_service</a>
    </div>
    <div>
        <a href="me_uddi_delete_tModel.html">uddi_delete_tmodel</a>
    </div>
    <div>
        <a href="me_uddi_discard_authToken.html">uddi_discard_authtok...</a>
    </div>
    <div>
        <a href="me_uddi_find_binding.html">uddi_find_binding</a>
    </div>
    <div>
        <a href="me_uddi_find_business.html">uddi_find_business</a>
    </div>
    <div>
        <a class="selected" href="me_uddi_find_service.html">uddi_find_service</a>
    </div>
    <div>
        <a href="me_uddi_find_tModel.html">uddi_find_tmodel</a>
    </div>
    <div>
        <a href="me_uddi_get_authToken.html">uddi_get_authtoken</a>
    </div>
    <div>
        <a href="me_uddi_get_bindingDetail.html">uddi_get_bindingdeta...</a>
    </div>
    <div>
        <a href="me_uddi_get_businessDetail.html">uddi_get_businessdet...</a>
    </div>
    <div>
        <a href="me_uddi_get_businessDetailExt.html">uddi_get_businessdet...</a>
    </div>
    <div>
        <a href="me_uddi_get_registeredInfo.html">uddi_get_registeredi...</a>
    </div>
    <div>
        <a href="me_uddi_get_serviceDetail.html">uddi_get_servicedeta...</a>
    </div>
    <div>
        <a href="me_uddi_get_tModelDetail.html">uddi_get_tmodeldetai...</a>
    </div>
    <div>
        <a href="me_uddi_save_binding.html">uddi_save_binding</a>
    </div>
    <div>
        <a href="me_uddi_save_business.html">uddi_save_business</a>
    </div>
    <div>
        <a href="me_uddi_save_service.html">uddi_save_service</a>
    </div>
    <div>
        <a href="me_uddi_save_tModel.html">uddi_save_tmodel</a>
    </div>
   </div>
   <div>
      <a href="functions.html#udt">User Defined Types &amp; The CLR</a>
   </div>
   <div>
      <a href="functions.html#vad">VAD</a>
   </div>
   <div>
      <a href="functions.html#jvmpl">Virtuoso Java PL API</a>
   </div>
   <div>
      <a href="functions.html#bif">Virtuoso Server Extension Interface (VSEI)</a>
   </div>
   <div>
      <a href="functions.html#ws">Web &amp; Internet</a>
   </div>
   <div>
      <a href="functions.html#xml">XML</a>
   </div>
   <div>
      <a href="functions.html#XPATH">XPATH &amp; XQUERY</a>
   </div>
    <br />
   <div>
      <a href="functionidx.html">Functions Index</a>
   </div>
    <br />
  </div>
  <div id="text">
    <h2>uddi_find_service</h2>
    <div class="refpurpose">Retrieves serviceList message matching search criteria</div>
  
  
  <div class="refsect1">
      <div class="refsect1title">Syntax</div>
    <div>
        <pre class="screen">
&lt;uddi_find_service
  businessKey=&quot;uuid_key&quot;
  generic=&quot;1.0&quot;
  [ maxRows =&quot;nn&quot; ]
  xmlns=&quot;urn:uddi-org:api&quot; &gt;
	[&lt;findQualifiers/&gt;]
	&lt;name/&gt; | &lt;categoryBag/&gt; | &lt;tModelBag/&gt;
&lt;/uddi_find_service&gt;
  </pre>
      </div>
    </div>
  <div class="refsect1">
      <div class="refsect1title">Attributes &amp; Children</div>
    <p>
The <span class="computeroutput">name</span>, <span class="computeroutput">categoryBag</span>, and <span class="computeroutput">tModelBag</span> arguments are mutually exclusive.
  </p>
    <div class="refsect2">
        <span class="refsect2title">maxRows – </span>This optional integer value allows
the requesting program to limit the number of results returned.
</div>
    <div class="refsect2">
        <span class="refsect2title">businessKey – </span>This <span class="computeroutput">uuid_key</span> is used to specify
a particular <span class="computeroutput">BusinessEntity</span> instance.</div>
    <div class="refsect2">
        <span class="refsect2title">findQualifiers – </span>This collection of
<span class="computeroutput">findQualifier</span> elements can be used to alter the default behavior of
search functionality.</div>
    <div class="refsect2">
        <span class="refsect2title">name – </span>This string value represents a
partial name.  Any <span class="computeroutput">businessService</span> data contained in the specified
<span class="computeroutput">businessEntity</span> with a matching partial name value gets returned.</div>
    <div class="refsect2">
        <span class="refsect2title">categoryBag – </span>This is a list of category
references.  The returned <span class="computeroutput">serviceList</span> contains <span class="computeroutput">businessInfo</span> structures
matching all of the categories passed (logical AND).</div>
    <div class="refsect2">
        <span class="refsect2title">tModelBag – </span>This is a list of <span class="computeroutput">tModel</span> <span class="computeroutput">uuid_key</span>
values that represent the technical fingerprint the server should locate within a
<span class="computeroutput">bindingTemplate</span> structure contained within any <span class="computeroutput">businessService</span> contained by
the <span class="computeroutput">businessEntity</span> specified.  If more than one <span class="computeroutput">tModel</span> key is specified
in this structure, only <span class="computeroutput">businessServices</span> that contain <span class="computeroutput">bindingTemplate</span>
information that matches all of the <span class="computeroutput">tModel</span> keys specified will be returned
(logical AND).</div>
  </div>
  <div class="refsect1">
      <div class="refsect1title">Return Types</div>
    <p>
This function returns a <span class="computeroutput">serviceList</span> on success.  In the event that no matches
were located for the specified criteria, the <span class="computeroutput">serviceList</span> structure returned
will contain an empty <span class="computeroutput">businessServices</span> structure.  This signifies zero matches.
  </p>
    <p>
In the event of a large number of matches, a UDDI-enabled server may truncate
the result set.  If this  occurs, the <span class="computeroutput">serviceList</span> will contain the
<span class="computeroutput">truncated</span> attribute with the value of this attribute set to true.
  </p>
    <p>
Searching using <span class="computeroutput">tModelBag</span> will return serviceInfo structures for all
qualifying <span class="computeroutput">businessService</span> data, including matches due to <span class="computeroutput">hostingRedirector</span>
references.  In other words, if the <span class="computeroutput">businessEntity</span> whose <span class="computeroutput">businessKey</span> is
passed as an argument contains a <span class="computeroutput">bindingTemplate</span> with a <span class="computeroutput">hostingRedirector</span>
value, and that value references a <span class="computeroutput">bindingTemplate</span> that matches the <span class="computeroutput">tModel</span>
search requirements, then the <span class="computeroutput">serviceInfo</span> for the <span class="computeroutput">businessService</span> containing
the <span class="computeroutput">hostingRedirector</span> will be returned.
  </p>
  </div>
  <div class="refsect1title">Errors</div>
    <table class="data">
      
       <tr>
        <th class="data">Error Code</th>
        <th class="data">Description</th>
      </tr>
	
	  <tr>
	    <td class="data">
          <a name="errE_invalidKeyPassed" />
          <span class="errorcode">E_invalidKeyPassed</span>
        </td>
	    <td class="data">signifies that the uuid_key value passed did not match
with any known businessKey or tModel key values.  The error structure
will signal which condition occurred first.</td>
	  </tr>
	  <tr>
	    <td class="data">
          <a name="errE_nameTooLong" />
          <span class="errorcode">E_nameTooLong</span>
        </td>
	    <td class="data">signifies that the partial name value passed exceeds
the maximum name length designated by the server.</td>
	  </tr>
	  <tr>
	    <td class="data">
          <a name="errE_tooManyOptions" />
          <span class="errorcode">E_tooManyOptions</span>
        </td>
	    <td class="data">signifies that more than one mutually exclusive argument
was passed.</td>
	  </tr>
	  <tr>
	    <td class="data">
          <a name="errE_unsupported" />
          <span class="errorcode">E_unsupported</span>
        </td>
	    <td class="data">signifies that one of the findQualifier values passed was invalid.</td>
	  </tr>
	
      
    </table>
    <br />
  <p />
</div>
  <div id="footer">
    <div>Copyright© 1999 - 2009 OpenLink Software All rights reserved.</div>
   <div id="validation">
    <a href="http://validator.w3.org/check/referer">
        <img src="http://www.w3.org/Icons/valid-xhtml10" alt="Valid XHTML 1.0!" height="31" width="88" />
    </a>
    <a href="http://jigsaw.w3.org/css-validator/">
        <img src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!" height="31" width="88" />
    </a>
   </div>
  </div>
 </body>
</html>