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
|
<?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="me_uddi_find_tModel">
<refmeta>
<refentrytitle>uddi_find_tModel</refentrytitle>
<refmiscinfo>uddi</refmiscinfo>
</refmeta>
<refnamediv>
<refname>uddi_find_tModel</refname>
<refpurpose>locate list of tModel entries matching supplied criteria</refpurpose>
</refnamediv>
<refsect1 id="syntax_uddi_find_tModel"><title>Syntax</title>
<screen>
<uddi_find_tModel
generic="1.0"
[ maxRows ="nn" ]
xmlns="urn:uddi-org:api" >
[<findQualifiers/>]
<name/> | <identifierBag/> | <categoryBag/>
</uddi_find_tModel>
</screen></refsect1>
<refsect1 id="desc_uddi_find_tModel"><title>Description</title>
<para>
This uddi_find_tModel message is for locating a list of tModel entries that match a
set of specific criteria. The response will be a list of abbreviated
information about tModels that match the criteria (tModelList).
</para></refsect1>
<refsect1 id="params_uddi_find_tModel"><title>Attributes & Children</title>
<para>The arguments to this call are mutually exclusive except findQualifiers</para>
<refsect2><title>maxRows</title><para>This optional integer value allows
the requesting program to limit the number of results returned.</para></refsect2>
<refsect2><title>findQualifiers</title><para>This collection of
findQualifier elements can be used to alter the default behavior of search
functionality.</para></refsect2>
<refsect2><title>name</title><para>This string value represents a partial
name. The returned tModelList contains tModelInfo structures for businesses
whose name matches the value passed (leftmost match).</para></refsect2>
<refsect2><title>IdentifierBag</title><para>This is a list of business identifier
references. The returned tModelList contains tModelInfo structures matching any
of the identifiers passed (logical OR).</para></refsect2>
<refsect2><title>categoryBag</title><para>This is a list of category references.
The returned tModelList contains tModelInfo structures matching all of the
categories passed (logical AND).</para></refsect2>
</refsect1>
<refsect1 id="ret_uddi_find_tModel"><title>Return Types</title>
<para>
This function returns a tModelList on success. In the event that no
matches were located for the specified criteria, an empty tModelList
structure will be returned (e.g. will contain zero tModelInfo
structures). This signifies zero matches.
</para>
<para>
In the event of a large number of matches, a UDDI-enabled server may truncate the
result set. If this occurs, the tModelList will contain the <parameter>truncated</parameter> attribute with
the value of this attribute set to true.
</para>
</refsect1>
<refsect1 id="errors_uddi_find_tModel"><title>Errors</title>
<para>
If an error occurs in processing this message, a <parameter>dispositionReport</parameter>
structure will be returned to the caller in a SOAP Fault. The following
error information will be relevant:
</para>
<table><title>Errors signalled by uddi_find_tModel</title>
<tgroup cols="2">
<thead><row><entry>Error Code</entry><entry>Description</entry></row></thead>
<tbody>
<row><entry><errorcode>E_nameTooLong</errorcode></entry>
<entry>signifies that the partial name value passed exceeds the maximum name
length designated by the UDDI-enabled server.</entry></row>
<row><entry><errorcode>E_tooManyOptions</errorcode></entry>
<entry>signifies that more than one mutually exclusive argument was passed.</entry></row>
<row><entry><errorcode>E_unsupported</errorcode></entry>
<entry>signifies that one of the findQualifier values passed was invalid.</entry></row>
</tbody>
</tgroup>
</table>
</refsect1>
</refentry>
|
