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
|
<?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_business">
<refmeta>
<refentrytitle>uddi_find_business</refentrytitle>
<refmiscinfo>uddi</refmiscinfo>
</refmeta>
<refnamediv>
<refname>uddi_find_business</refname>
<refpurpose>Retrieves a <parameter>businessList</parameter> message matching supplied criteria.</refpurpose>
</refnamediv>
<refsect1 id="syntax_uddi_find_business"><title>Syntax</title>
<screen>
<uddi_find_business
generic="1.0"
[ maxRows ="nn" ]
xmlns="urn:uddi-org:api" >
[<findQualifiers/>]
<name/> | <identifierBag/> | <categoryBag/> | <tModelBag/> | <discoveryURLs>
</uddi_find_business>
</screen></refsect1>
<refsect1 id="params_uddi_find_business"><title>Attributes & Children</title>
<para>
All arguments listed here are mutually exclusive except
<parameter>findQualifiers</parameter>.
</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
<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 is a partial name.
The <parameter>businessList</parameter> return message contains <parameter>businessInfo</parameter> 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 <parameter>businessList</parameter> contains <parameter>businessInfo</parameter>
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 <parameter>businessList</parameter> contains <parameter>businessInfo</parameter> structures
matching all of the categories passed (logical AND).
</para></refsect2>
<refsect2><title>tModelBag</title><para>The registered <parameter>businessEntity</parameter>
data contains <parameter>bindingTemplates</parameter> that in turn contain specific <parameter>tModel</parameter>
references. The <parameter>tModelBag</parameter> argument lets you search for businesses that
have bindings that are compatible with a specific <parameter>tModel</parameter> pattern. The
returned <parameter>businessList</parameter> contains <parameter>businessInfo</parameter> structures that match all of the
<parameter>tModel</parameter> keys passed (logical AND). <parameter>tModelKey</parameter> values must be formatted
as URN qualified uuid values (e.g. prefixed with "uuid:")</para></refsect2>
<refsect2><title>discoveryURLs</title><para>This is a list of URLs to
be matched against the data associated with the <parameter>discoveryURLs</parameter> contents of
registered <parameter>businessEntity</parameter> information. To search
for a URL without regard to
<parameter>useType</parameter> attribute values, pass the <parameter>useType</parameter> component of the <parameter>discoveryURL</parameter>
elements as empty attributes. If <parameter>useType</parameter> values are included, then the match
will be made only on registered information that matches both the <parameter>useType</parameter> and
URL value. The returned <parameter>businessList</parameter> contains <parameter>businessInfo</parameter> structures matching
any of the URLs passed (logical OR). </para></refsect2>
</refsect1>
<refsect1 id="ret_uddi_find_business"><title>Return Types</title>
<para>
This function returns a <parameter>businessList</parameter> on success. In the event that no
matches were located for the specified criteria, a <parameter>businessList</parameter> structure
with zero <parameter>businessInfo</parameter> structures is returned.
</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>businessList</parameter> will contain the <parameter>truncated</parameter>
attribute with the value set to true.
</para>
<para>
Searching using <parameter>tModelBag</parameter> will also return any <parameter>businessEntity</parameter> that contains
<parameter>bindingTemplate</parameter> information that matches due to <parameter>hostingRedirector</parameter> references.
In other words, the <parameter>businessEntity</parameter> that contains a <parameter>bindingTemplate</parameter> with a
<parameter>hostingRedirector</parameter> value referencing a <parameter>bindingTemplate</parameter> that matches the <parameter>tModel</parameter>
search requirements will be returned.
</para>
</refsect1>
<refsect1 id="errors_uddi_find_business"><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 get_authToken</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 search 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>
|
