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
|
<?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_delete_tModel">
<refmeta>
<refentrytitle>uddi_delete_tModel</refentrytitle>
<refmiscinfo>uddi</refmiscinfo>
</refmeta>
<refnamediv>
<refname>uddi_delete_tModel</refname>
<refpurpose>Remove or retire one or more <parameter>tModel</parameter> structures.</refpurpose>
</refnamediv>
<refsect1 id="syntax_uddi_delete_tModel"><title>Syntax</title>
<screen>
<uddi_delete_tModel
generic="1.0"
xmlns="urn:uddi-org:api" >
<authInfo/>
<tModelKey/>
[ <tModelKey/> ...]
</uddi_delete_tModel>
</screen></refsect1>
<refsect1 id="params_uddi_delete_tModel"><title>Attributes & Children</title>
<refsect2><title>authInfo</title><para>This required argument is an element
that contains an authentication token obtained using the
<parameter>get_authToken</parameter> call.</para></refsect2>
<refsect2><title>tModelKey </title><para>One or more URN-qualified
<parameter>uuid_key</parameter> values that represent specific instances
of known <parameter>tModel</parameter> data. All <parameter>tModelKey</parameter>
values begin with a uuid URN qualifier (e.g. "uuid:" followed by a known
tModel UUID value.)</para></refsect2>
</refsect1>
<refsect1 id="ret_uddi_delete_tModel"><title>Return Types</title>
<para>Upon successful completion, a <parameter>dispositionReport</parameter>
structure is returned with a single success indicator.</para>
<refsect2><title>Behavior</title><para>If a <parameter>tModel</parameter> is deleted
and any other managed data references that <parameter>tModel</parameter> by
<parameter>uuid_key</parameter> (e.g. within a <parameter>categoryBag</parameter>,
<parameter>identifierBag</parameter> or within a <parameter>tModelInstanceInfo</parameter>
structure) then the <parameter>tModel</parameter> will not be physically deleted as a
result of this call. Instead it will be marked as hidden.
<parameter>tModels</parameter> hidden in this way are still accessible
to their owner, via the <parameter>get_registeredInfo</parameter> call;
however, they will be omitted from any results returned by calls to
<parameter>find_tModel</parameter>.</para>
<para>The details associated with a hidden <parameter>tModel</parameter>
are still available to anyone who uses the <parameter>get_tModelDetail</parameter>
message. Publishers who want to remove all details about a <parameter>tModel</parameter>
from the system should call <parameter>save_tModel</parameter>, passing empty values
in the data fields, before using <parameter>uddi_delete_tModel</parameter>. A
hidden <parameter>tModel</parameter> can be restored and made universally visible
by invoking <parameter>save</parameter>_tModel at a later time, passing the key of the
hidden <parameter>tModel</parameter>.</para></refsect2>
</refsect1>
<refsect1 id="errors_uddi_delete_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_delete_tModel</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 one of the URN-qualified
<parameter>uuid_key</parameter> values passed did not match with any known
<parameter>tModelKey</parameter> values. No partial results will be
returned; if any <parameter>tModelKey</parameter> values passed are not
valid, this error will be returned.
Any <parameter>tModelKey</parameter> values passed without a uuid URN qualifier will be considered invalid.</entry>
</row>
<row>
<entry><errorcode>E_authTokenExpired</errorcode></entry>
<entry>signifies that the authentication token value passed in the <parameter>authInfo</parameter> argument
is no longer valid because the token has expired.</entry>
</row>
<row>
<entry><errorcode>E_authTokenRequired</errorcode></entry>
<entry>signifies that the authentication token value passed in the <parameter>authInfo</parameter>
argument is either missing or is not valid.</entry>
</row>
<row>
<entry><errorcode>E_userMismatch</errorcode></entry>
<entry>signifies that one or more of the <parameter>tModelKey</parameter> values passed refers to data
not controlled by the entity the
authentication token represents.</entry>
</row>
<row>
<entry><errorcode>E_operatorMismatch</errorcode></entry>
<entry>signifies that one or more of the <parameter>tModelKey</parameter> values passed refers to data
that is not controlled by the server that received the request
for processing.</entry>
</row>
</tbody>
</tgroup>
</table>
</refsect1>
</refentry>
|
