summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/sdbc/KeyRule.idl
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 09:06:44 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 09:06:44 +0000
commited5640d8b587fbcfed7dd7967f3de04b37a76f26 (patch)
tree7a5f7c6c9d02226d7471cb3cc8fbbf631b415303 /offapi/com/sun/star/sdbc/KeyRule.idl
parentInitial commit. (diff)
downloadlibreoffice-upstream.tar.xz
libreoffice-upstream.zip
Adding upstream version 4:7.4.7.upstream/4%7.4.7upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to '')
-rw-r--r--offapi/com/sun/star/sdbc/KeyRule.idl161
1 files changed, 161 insertions, 0 deletions
diff --git a/offapi/com/sun/star/sdbc/KeyRule.idl b/offapi/com/sun/star/sdbc/KeyRule.idl
new file mode 100644
index 000000000..30eae77a6
--- /dev/null
+++ b/offapi/com/sun/star/sdbc/KeyRule.idl
@@ -0,0 +1,161 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+#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
+ com::sun::star::sdbc::XResultSet
+ objects returned by the methods
+ com::sun::star::sdbc::XDatabaseMetaData::getImportedKeys(),
+ com::sun::star::sdbc::XDatabaseMetaData::getExportedKeys(),
+ and com::sun::star::sdbc::XDatabaseMetaData::getCrossReference().
+ <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
+ com::sun::star::sdbc::XResultSet
+ objects returned by the methods
+ com::sun::star::sdbc::XDatabaseMetaData::getImportedKeys(),
+ com::sun::star::sdbc::XDatabaseMetaData::getExportedKeys(),
+ and com::sun::star::sdbc::XDatabaseMetaData::getCrossReference().
+ <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
+ com::sun::star::sdbc::XResultSet
+ objects returned by the methods
+ com::sun::star::sdbc::XDatabaseMetaData::getImportedKeys(),
+ com::sun::star::sdbc::XDatabaseMetaData::getExportedKeys(),
+ and com::sun::star::sdbc::XDatabaseMetaData::getCrossReference().
+ <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
+ com::sun::star::sdbc::XResultSet
+ objects returned by the methods
+ com::sun::star::sdbc::XDatabaseMetaData::getImportedKeys(),
+ com::sun::star::sdbc::XDatabaseMetaData::getExportedKeys(),
+ and com::sun::star::sdbc::XDatabaseMetaData::getCrossReference().
+ <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
+ com::sun::star::sdbc::XResultSet
+ objects returned by the methods
+ com::sun::star::sdbc::XDatabaseMetaData::getImportedKeys(),
+ com::sun::star::sdbc::XDatabaseMetaData::getExportedKeys(),
+ and com::sun::star::sdbc::XDatabaseMetaData::getCrossReference().
+ <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
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */