Sophie

Sophie

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

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: soap_dt_define - Virtuoso Functions Guide" />
  <meta name="dc.subject" content="Function: soap_dt_define - 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: soap_dt_define - 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="fn_soap_dt_define" />
    <img src="../images/misc/logo.jpg" alt="" />
    <h1>22. Virtuoso Functions Guide - soap_dt_define</h1>
  </div>
  <div id="navbartop">
   <div>
      <a class="link" href="functions.html">Chapter Contents</a> | <a class="link" href="fn_soap_box_xml_entity.html" title="soap_box_xml_entity">Prev</a> | <a class="link" href="fn_soap_call.html" title="soap_call">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 class="selected" href="functions.html#soap">SOAP</a>
   </div>
   <div class="selected">
    <div>
        <a href="fn_http_body_read.html">http_body_read</a>
    </div>
    <div>
        <a href="fn_soap_box_structure.html">soap_box_structure</a>
    </div>
    <div>
        <a href="fn_soap_box_xml_entity.html">soap_box_xml_entity</a>
    </div>
    <div>
        <a href="fn_soap_call.html">soap_call</a>
    </div>
    <div>
        <a href="fn_soap_client.html">soap_client</a>
    </div>
    <div>
        <a href="fn_soap_current_url.html">soap_current_url</a>
    </div>
    <div>
        <a class="selected" href="fn_soap_dt_define.html">soap_dt_define</a>
    </div>
    <div>
        <a href="fn_soap_make_error.html">soap_make_error</a>
    </div>
    <div>
        <a href="fn_soap_print_box.html">soap_print_box</a>
    </div>
    <div>
        <a href="fn_soap_sdl.html">soap_sdl</a>
    </div>
    <div>
        <a href="fn_soap_server.html">soap_server</a>
    </div>
    <div>
        <a href="fn_soap_wsdl.html">soap_wsdl</a>
    </div>
    <div>
        <a href="fn_soap_wsdl_import.html">soap_wsdl_import</a>
    </div>
    <div>
        <a href="fn_wst_cli.html">wst_cli</a>
    </div>
   </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 href="functions.html#uddi">UDDI</a>
   </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>soap_dt_define</h2>
    <div class="refpurpose">define re-define or erase the complex datatype definition for SOAP calls</div>
    <div class="funcsynopsis">
        <span class="funcdef">
     <span class="function">soap_dt_define</span>
     </span>
        (<span class="paramdef">in <span class="parameter">name</span>varchar</span>, 
        <span class="paramdef">in <span class="parameter">schema_string</span>varchar</span>);
      </div>
  
  
  
  <div class="refsect1">
      <div class="refsect1title">Description</div>
		<p>This defines a new complex SOAP datatype (usually array of structure) named &#39;name&#39;.</p>
    <p>The schema_string string represents definition as complexType element from XML Schema.
The only complexContent, all and sequence elements can be used within the complexType. This means that 
optional elements in the defined datatype are not supported as a variant of the SOAP parameter datatype.
If the schema descriptions contains an unsupported element , the SQL error will be signalled and error message 
will explain what element is wrong.</p>
</div>
  <div class="refsect1">
    <div class="refsect1title">Parameters</div>
    <div class="refsect2">
        <span class="refsect2title">name – </span>
      A varchar containing the expanded name of SOAP type to be 
      defined/removed or an empty string (&#39;&#39;).  If an empty string is supplied 
      this function will try to extract it from the given schema_string schema 
      fragment (attribute @name&#39;).  Name cannot be an empty string for removing 
      SOAP types.
      his function is implemented as a stored procedure and hence should 
      be referenced fully qualified as DB.DBA.soap_dt_define() if the current
      catalogue cannot be guaranteed to be DB.
    </div>
    <div class="refsect2">
        <span class="refsect2title">schema_string – </span>
      XMLSchema excerpt as varchar or NULL (null is used for removal).
    </div>
  </div>
  <div class="refsect1">
      <div class="refsect1title">Return Types</div>
    <p>This function returns a varchar of the name of the registered 
    SOAP type.</p>
  </div>
  
    <div class="refsect1title">Errors</div>
    <p>This function can generate the following errors:</p>
    <div class="msgentry">
      <div class="msg">
        <a name="errSODT1" />
        <span class="errorcode">SODT1</span>
        <span class="errortype">22023</span>
        <span class="errorname">The element &lt;element name&gt; is not supported [&lt;as child of complexContent&gt;]</span>
      </div>
    </div>
  <p />

<div class="refsect1">
      <div class="refsect1title">Examples</div>
    <a name="" />
      <div class="example">
        <div class="exampletitle">Definition of an Array</div>
<div>
          <pre class="programlisting">


&lt;!-- file float_array.xsd --&gt;
&lt;complexType name=&quot;ArrayOffloat&quot;
   xmlns:enc=&quot;http://schemas.xmlsoap.org/soap/encoding/&quot; 
   xmlns:wsdl=&quot;http://schemas.xmlsoap.org/wsdl/&quot; 
   xmlns=&quot;http://www.w3.org/2001/XMLSchema&quot;
   xmlns:tns=&quot;services.wsdl&quot;&gt;
   &lt;complexContent&gt;
   &lt;restriction base=&quot;enc:Array&quot;&gt;
   &lt;sequence&gt;
   &lt;element name=&quot;item&quot; type=&quot;float&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;unbounded&quot; nillable=&quot;true&quot;/&gt;
   &lt;/sequence&gt;
   &lt;attributeGroup ref=&quot;enc:commonAttributes&quot;/&gt;
   &lt;attribute ref=&quot;enc:offset&quot;/&gt;
   &lt;attribute ref=&quot;enc:arrayType&quot; wsdl:arrayType=&quot;float[]&quot;/&gt;
   &lt;/restriction&gt;
   &lt;/complexContent&gt;
&lt;/complexType&gt;
&lt;!-- eof float_array.xsd --&gt;

can be defined from ISQL tool or in the PL procedure
SQL&gt; DB.DBA.soap_dt_define (&#39;ArrayOffloat&#39;, file_to_string (&#39;float_array.xsd&#39;));


</pre>
        </div>
    </div>
<a name="" />
      <div class="example">
        <div class="exampletitle">Definition of an Structure</div>
<div>
          <pre class="programlisting">


&lt;!-- file struct.xsd --&gt;
&lt;complexType name=&quot;PERSON&quot;
   xmlns:enc=&quot;http://schemas.xmlsoap.org/soap/encoding/&quot; 
   xmlns:wsdl=&quot;http://schemas.xmlsoap.org/wsdl/&quot; 
   xmlns=&quot;http://www.w3.org/2001/XMLSchema&quot;
   xmlns:tns=&quot;services.wsdl&quot;&gt;

   &lt;sequence&gt;
     &lt;element name=&quot;firstName&quot; type=&quot;string&quot;/&gt;
     &lt;element name=&quot;lastName&quot; type=&quot;string&quot;/&gt;
     &lt;element name=&quot;ageInYears&quot; type=&quot;int&quot;/&gt;
     &lt;element name=&quot;weightInLbs&quot; type=&quot;float&quot;/&gt;
     &lt;element name=&quot;heightInInches&quot; type=&quot;float&quot;/&gt;
   &lt;/sequence&gt;
&lt;/complexType&gt;
&lt;!-- eof struct.xsd --&gt;

can be defined from ISQL tool or in the PL procedure
SQL&gt; DB.DBA.soap_dt_define (&#39;PERSON&#39;, file_to_string (&#39;struct.xsd&#39;));


</pre>
        </div>
    </div>
<a name="" />
      <div class="example">
        <div class="exampletitle">Definition of composite type array of structures</div>
<div>
          <pre class="programlisting">


&lt;!-- file array_struct.xsd --&gt;
&lt;complexType name=&quot;ArrayOfPERSON&quot;
   xmlns:enc=&quot;http://schemas.xmlsoap.org/soap/encoding/&quot; 
   xmlns:wsdl=&quot;http://schemas.xmlsoap.org/wsdl/&quot; 
   xmlns=&quot;http://www.w3.org/2001/XMLSchema&quot;
   xmlns:tns=&quot;services.wsdl&quot;&gt;
   
   &lt;complexContent&gt;
   &lt;restriction base=&quot;enc:Array&quot;&gt;
   &lt;sequence&gt;
   &lt;element name=&quot;item&quot; type=&quot;tns:PERSON&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;unbounded&quot; nillable=&quot;true&quot;/&gt;
   &lt;/sequence&gt;
   &lt;attributeGroup ref=&quot;enc:commonAttributes&quot;/&gt;
   &lt;attribute ref=&quot;enc:offset&quot;/&gt;
   &lt;attribute ref=&quot;enc:arrayType&quot; wsdl:arrayType=&quot;tns:PERSON[]&quot;/&gt;
   &lt;/restriction&gt;
   &lt;/complexContent&gt;

&lt;/complexType&gt;
&lt;!-- eof array_struct.xsd --&gt;

can be defined from ISQL tool or in the PL procedure
SQL&gt; DB.DBA.soap_dt_define (&#39;ArrayOfPERSON&#39;, file_to_string (&#39;array_struct.xsd&#39;));


</pre>
        </div>
    </div>
</div>
</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>

Perl :: Catalyst :: PostgreSQL :: RPM Valid HTML 4.01 Transitional