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
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2008 by Sun Microsystems, Inc.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: KeyRule.idl,v $
* $Revision: 1.10 $
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org 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 Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef __com_sun_star_sdbc_KeyRule_idl__
#define __com_sun_star_sdbc_KeyRule_idl__
module com { module sun { module star { module sdbc {
/** determines the rules for foreign key constraints.
*/
published constants KeyRule
{
/** a possible value for the column's
<code>UPDATE_RULE</code>
and
<code>DELETE_RULE</code>
in the
<type scope="com::sun::star::sdbc">XResultSet</type>
objects returned by the methods
<member scope="com::sun::star::sdbc">XDatabaseMetaData::getImportedKeys()</member>
,
<member scope="com::sun::star::sdbc">XDatabaseMetaData::getExportedKeys()</member>
,
and
<member scope="com::sun::star::sdbc">XDatabaseMetaData::getCrossReference()</member>
.
<P>
For the column
<code>UPDATE_RULE</code>
,
it indicates that
when the primary key is updated, the foreign key (imported key)
is changed to agree with it.
</P>
<P>
For the column
<code>DELETE_RULE</code>
,
it indicates that
when the primary key is deleted, rows that imported that key
are deleted.
</P>
*/
const long CASCADE = 0;
//-------------------------------------------------------------------------
/** a possible value for the column's
<code>UPDATE_RULE</code>
and
<code>DELETE_RULE</code>
in the
<type scope="com::sun::star::sdbc">XResultSet</type>
objects returned by the methods
<member scope="com::sun::star::sdbc">XDatabaseMetaData::getImportedKeys()</member>
,
<member scope="com::sun::star::sdbc">XDatabaseMetaData::getExportedKeys()</member>
,
and
<member scope="com::sun::star::sdbc">XDatabaseMetaData::getCrossReference()</member>
.
<P>
For the column
<code>UPDATE_RULE</code>
, it indicates that
a primary key may not be updated if it has been imported by
another table as a foreign key.
</P>
<P>
For the column
<code>DELETE_RULE</code>
, it indicates that
a primary key may not be deleted if it has been imported by
another table as a foreign key.
</P>
*/
const long RESTRICT = 1;
//-------------------------------------------------------------------------
/** a possible value for the column's
<code>UPDATE_RULE</code>
and
<code>DELETE_RULE</code>
in the
<type scope="com::sun::star::sdbc">XResultSet</type>
objects returned by the methods
<member scope="com::sun::star::sdbc">XDatabaseMetaData::getImportedKeys()</member>
,
<member scope="com::sun::star::sdbc">XDatabaseMetaData::getExportedKeys()</member>
,
and
<member scope="com::sun::star::sdbc">XDatabaseMetaData::getCrossReference()</member>
.
<P>
For the columns
<code>UPDATE_RULE</code>
and
<code>DELETE_RULE</code>
,
it indicates that
when the primary key is updated or deleted, the foreign key (imported key)
is changed to <code>NULL</code>.
</P>
*/
const long SET_NULL = 2;
//-------------------------------------------------------------------------
/** a possible value for the column's
<code>UPDATE_RULE</code>
and
<code>DELETE_RULE</code>
in the
<type scope="com::sun::star::sdbc">XResultSet</type>
objects returned by the methods
<member scope="com::sun::star::sdbc">XDatabaseMetaData::getImportedKeys()</member>
,
<member scope="com::sun::star::sdbc">XDatabaseMetaData::getExportedKeys()</member>
,
and
<member scope="com::sun::star::sdbc">XDatabaseMetaData::getCrossReference()</member>
.
<P>
For the columns
<code>UPDATE_RULE</code>
and
<code>DELETE_RULE</code>
,
it indicates that if the primary key has been imported, it cannot be updated or deleted.
</P>
*/
const long NO_ACTION = 3;
//-------------------------------------------------------------------------
/** a possible value for the column's
<code>UPDATE_RULE</code>
and
<code>DELETE_RULE</code>
in the
<type scope="com::sun::star::sdbc">XResultSet</type>
objects returned by the methods
<member scope="com::sun::star::sdbc">XDatabaseMetaData::getImportedKeys()</member>
,
<member scope="com::sun::star::sdbc">XDatabaseMetaData::getExportedKeys()</member>
,
and
<member scope="com::sun::star::sdbc">XDatabaseMetaData::getCrossReference()</member>
.
<P>
For the columns
<code>UPDATE_RULE</code>
and
<code>DELETE_RULE</code>
,
it indicates that
if the primary key is updated or deleted, the foreign key (imported key)
is set to the default value.
</P>
*/
const long SET_DEFAULT = 4;
};
//=============================================================================
}; }; }; };
/*===========================================================================
===========================================================================*/
#endif
|
