summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/sdbcx/Key.idl
diff options
context:
space:
mode:
Diffstat (limited to 'offapi/com/sun/star/sdbcx/Key.idl')
-rw-r--r--offapi/com/sun/star/sdbcx/Key.idl84
1 files changed, 84 insertions, 0 deletions
diff --git a/offapi/com/sun/star/sdbcx/Key.idl b/offapi/com/sun/star/sdbcx/Key.idl
new file mode 100644
index 000000000..7465f6e57
--- /dev/null
+++ b/offapi/com/sun/star/sdbcx/Key.idl
@@ -0,0 +1,84 @@
+/* -*- 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_sdbcx_Key_idl__
+#define __com_sun_star_sdbcx_Key_idl__
+
+#include <com/sun/star/beans/XPropertySet.idl>
+
+ module com { module sun { module star { module sdbcx {
+
+ published interface XColumnsSupplier;
+ published interface XDataDescriptorFactory;
+
+
+/** is used to define a new key for a table.
+ */
+published service Key
+{
+
+ /** optional, could be used to copy a key.
+ */
+ [optional] interface XDataDescriptorFactory;
+
+
+ /** access to the contained key columns.
+ */
+ interface XColumnsSupplier;
+
+ // gives access to the properties.
+ interface com::sun::star::beans::XPropertySet;
+
+
+ /** is the name of the key
+ */
+ [readonly, property] string Name;
+
+
+ /** indicates the type of the key.
+ @see com::sun::star::sdbcx::KeyType
+ */
+ [readonly, property] long Type;
+
+
+ /** is the name of the referenced table, only used for foreign
+ keys.
+ */
+ [readonly, property] string ReferencedTable;
+
+
+ /** is the rule which is applied for updates; only used for foreign keys.
+ @see com::sun::star::sdbc::KeyRule
+ */
+ [readonly, property] long UpdateRule;
+
+
+ /** is the rule which is applied for deletions; only used for foreign keys.
+ @see com::sun::star::sdbc::KeyRule
+ */
+ [readonly, property] long DeleteRule;
+};
+
+
+}; }; }; };
+
+/*===========================================================================
+===========================================================================*/
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */