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
|
<?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_service">
<refmeta>
<refentrytitle>uddi_find_service</refentrytitle>
<refmiscinfo>uddi</refmiscinfo>
</refmeta>
<refnamediv>
<refname>uddi_find_service</refname>
<refpurpose>Retrieves <parameter>serviceList</parameter> message matching search criteria</refpurpose>
</refnamediv>
<refsect1 id="syntax_uddi_find_service"><title>Syntax</title>
<screen>
<uddi_find_service
businessKey="uuid_key"
generic="1.0"
[ maxRows ="nn" ]
xmlns="urn:uddi-org:api" >
[<findQualifiers/>]
<name/> | <categoryBag/> | <tModelBag/>
</uddi_find_service>
</screen></refsect1>
<refsect1 id="params_uddi_find_service"><title>Attributes & Children</title>
<para>
The <parameter>name</parameter>, <parameter>categoryBag</parameter>, and <parameter>tModelBag</parameter> arguments are mutually exclusive.
</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>businessKey</title><para>This <parameter>uuid_key</parameter> is used to specify
a particular <parameter>BusinessEntity</parameter> instance.</para></refsect2>
<refsect2><title>findQualifiers</title><para>This collection of
<parameter>findQualifier</parameter> 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. Any <parameter>businessService</parameter> data contained in the specified
<parameter>businessEntity</parameter> with a matching partial name value gets returned.</para></refsect2>
<refsect2><title>categoryBag</title><para>This is a list of category
references. The returned <parameter>serviceList</parameter> contains <parameter>businessInfo</parameter> structures
matching all of the categories passed (logical AND).</para></refsect2>
<refsect2><title>tModelBag</title><para>This is a list of <parameter>tModel</parameter> <parameter>uuid_key</parameter>
values that represent the technical fingerprint the server should locate within a
<parameter>bindingTemplate</parameter> structure contained within any <parameter>businessService</parameter> contained by
the <parameter>businessEntity</parameter> specified. If more than one <parameter>tModel</parameter> key is specified
in this structure, only <parameter>businessServices</parameter> that contain <parameter>bindingTemplate</parameter>
information that matches all of the <parameter>tModel</parameter> keys specified will be returned
(logical AND).</para></refsect2>
</refsect1>
<refsect1 id="ret_uddi_find_service"><title>Return Types</title>
<para>
This function returns a <parameter>serviceList</parameter> on success. In the event that no matches
were located for the specified criteria, the <parameter>serviceList</parameter> structure returned
will contain an empty <parameter>businessServices</parameter> structure. 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 <parameter>serviceList</parameter> will contain the
<parameter>truncated</parameter> attribute with the value of this attribute set to true.
</para>
<para>
Searching using <parameter>tModelBag</parameter> will return serviceInfo structures for all
qualifying <parameter>businessService</parameter> data, including matches due to <parameter>hostingRedirector</parameter>
references. In other words, if the <parameter>businessEntity</parameter> whose <parameter>businessKey</parameter> is
passed as an argument contains a <parameter>bindingTemplate</parameter> with a <parameter>hostingRedirector</parameter>
value, and that value references a <parameter>bindingTemplate</parameter> that matches the <parameter>tModel</parameter>
search requirements, then the <parameter>serviceInfo</parameter> for the <parameter>businessService</parameter> containing
the <parameter>hostingRedirector</parameter> will be returned.
</para>
</refsect1>
<refsect1 id="errors_uddi_find_service"><title>Errors</title>
<table><title>Errors signalled by uddi_find_service</title>
<tgroup cols="2">
<thead><row><entry>Error Code</entry><entry>Description</entry></row></thead>
<tbody>
<row>
<entry><errorcode>E_invalidKeyPassed</errorcode></entry>
<entry>signifies that the <parameter>uuid_key</parameter> value passed did not match
with any known <parameter>businessKey</parameter> or <parameter>tModel</parameter> key values. The error structure
will signal which condition occurred first.</entry>
</row>
<row>
<entry><errorcode>E_nameTooLong</errorcode></entry>
<entry>signifies that the partial name value passed exceeds
the maximum name length designated by the 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 <parameter>findQualifier</parameter> values passed was invalid.</entry>
</row>
</tbody>
</tgroup>
</table>
</refsect1>
</refentry>
|
