1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
|
<?xml version="1.0" encoding="ISO-8859-1"?>
<!--
-
- This file is part of the OpenLink Software Virtuoso Open-Source (VOS)
- project.
-
- Copyright (C) 1998-2018 OpenLink Software
-
- This project is free software; you can redistribute it and/or modify it
- under the terms of the GNU General Public License as published by the
- Free Software Foundation; only version 2 of the License, dated June 1991.
-
- This program is distributed in the hope that it will be useful, but
- WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- General Public License for more details.
-
- You should have received a copy of the GNU General Public License along
- with this program; if not, write to the Free Software Foundation, Inc.,
- 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
-
-
-->
<refentry id="fn_soap_dt_define">
<refmeta>
<refentrytitle>soap_dt_define</refentrytitle>
<refmiscinfo>soap</refmiscinfo>
</refmeta>
<refnamediv>
<refname>soap_dt_define</refname>
<refpurpose>define re-define or erase the complex datatype definition for SOAP calls</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis id="fsyn_soap_dt_define">
<funcprototype id="fproto_soap_dt_define">
<funcdef><function>soap_dt_define</function></funcdef>
<paramdef>in <parameter>name</parameter>varchar</paramdef>
<paramdef>in <parameter>schema_string</parameter>varchar</paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="desc"><title>Description</title>
<para>This defines a new complex SOAP datatype (usually array of structure) named 'name'.</para>
<para>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.</para>
</refsect1>
<refsect1 id="params_">
<title>Parameters</title>
<refsect2><title>name</title>
<para>A varchar containing the expanded name of SOAP type to be
defined/removed or an empty string (''). If an empty string is supplied
this function will try to extract it from the given schema_string schema
fragment (attribute @name'). Name cannot be an empty string for removing
SOAP types.</para>
<para>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.</para>
</refsect2>
<refsect2><title>schema_string</title>
<para>XMLSchema excerpt as varchar or NULL (null is used for removal).</para>
</refsect2>
</refsect1>
<refsect1 id="ret_"><title>Return Types</title>
<para>This function returns a varchar of the name of the registered
SOAP type.</para>
</refsect1>
<refsect1 id="errors_">
<title>Errors</title>
<para>This function can generate the following errors:</para>
<msgentry>
<msg><msgmain><msgtext><errorcode>SODT1</errorcode><errortype>22023</errortype>
<errorname>The element <element name> is not supported [<as child of complexContent>]</errorname>
</msgtext></msgmain></msg>
</msgentry>
</refsect1>
<refsect1 id="examples"><title>Examples</title>
<example ID="VDOCS-SOAP-DT-01"><title>Definition of an Array</title>
<programlisting>
<![CDATA[
<!-- file float_array.xsd -->
<complexType name="ArrayOffloat"
xmlns:enc="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/"
xmlns="http://www.w3.org/2001/XMLSchema"
xmlns:tns="services.wsdl">
<complexContent>
<restriction base="enc:Array">
<sequence>
<element name="item" type="float" minOccurs="0" maxOccurs="unbounded" nillable="true"/>
</sequence>
<attributeGroup ref="enc:commonAttributes"/>
<attribute ref="enc:offset"/>
<attribute ref="enc:arrayType" wsdl:arrayType="float[]"/>
</restriction>
</complexContent>
</complexType>
<!-- eof float_array.xsd -->
can be defined from ISQL tool or in the PL procedure
SQL> DB.DBA.soap_dt_define ('ArrayOffloat', file_to_string ('float_array.xsd'));
]]>
</programlisting>
</example>
<example ID="VDOCS-SOAP-DT-02"><title>Definition of an Structure</title>
<programlisting>
<![CDATA[
<!-- file struct.xsd -->
<complexType name="PERSON"
xmlns:enc="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/"
xmlns="http://www.w3.org/2001/XMLSchema"
xmlns:tns="services.wsdl">
<sequence>
<element name="firstName" type="string"/>
<element name="lastName" type="string"/>
<element name="ageInYears" type="int"/>
<element name="weightInLbs" type="float"/>
<element name="heightInInches" type="float"/>
</sequence>
</complexType>
<!-- eof struct.xsd -->
can be defined from ISQL tool or in the PL procedure
SQL> DB.DBA.soap_dt_define ('PERSON', file_to_string ('struct.xsd'));
]]>
</programlisting>
</example>
<example ID="VDOCS-SOAP-DT-03"><title>Definition of composite type array of structures</title>
<programlisting>
<![CDATA[
<!-- file array_struct.xsd -->
<complexType name="ArrayOfPERSON"
xmlns:enc="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/"
xmlns="http://www.w3.org/2001/XMLSchema"
xmlns:tns="services.wsdl">
<complexContent>
<restriction base="enc:Array">
<sequence>
<element name="item" type="tns:PERSON" minOccurs="0" maxOccurs="unbounded" nillable="true"/>
</sequence>
<attributeGroup ref="enc:commonAttributes"/>
<attribute ref="enc:offset"/>
<attribute ref="enc:arrayType" wsdl:arrayType="tns:PERSON[]"/>
</restriction>
</complexContent>
</complexType>
<!-- eof array_struct.xsd -->
can be defined from ISQL tool or in the PL procedure
SQL> DB.DBA.soap_dt_define ('ArrayOfPERSON', file_to_string ('array_struct.xsd'));
]]>
</programlisting>
</example>
</refsect1>
</refentry>
|
