summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/sdbcx/Index.idl
diff options
context:
space:
mode:
Diffstat (limited to 'offapi/com/sun/star/sdbcx/Index.idl')
-rw-r--r--offapi/com/sun/star/sdbcx/Index.idl88
1 files changed, 88 insertions, 0 deletions
diff --git a/offapi/com/sun/star/sdbcx/Index.idl b/offapi/com/sun/star/sdbcx/Index.idl
new file mode 100644
index 000000000..1d25db0dc
--- /dev/null
+++ b/offapi/com/sun/star/sdbcx/Index.idl
@@ -0,0 +1,88 @@
+/* -*- 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_Index_idl__
+#define __com_sun_star_sdbcx_Index_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 specify the index for a database table. It refers to one or
+ more columns of a table.
+ <p>
+ <b>
+ Note:
+ </b>
+ All properties and columns of an index could by modified before they are appended
+ to a table. In that case the service is a data descriptor.
+ </p>
+ */
+published service Index
+{
+
+ /** optional, could be used to copy an index.
+ */
+ [optional] interface XDataDescriptorFactory;
+
+
+ /** access to the contained index columns.
+ */
+ interface XColumnsSupplier;
+
+ // gives access to the properties.
+ interface com::sun::star::beans::XPropertySet;
+
+
+ /** is the name of the index.
+ */
+ [readonly, property] string Name;
+
+
+ /** is the name of the index catalog, may be empty.
+ */
+ [readonly, property] string Catalog;
+
+
+ /** indicates that the index allow only unique values.
+ */
+ [readonly, property] boolean IsUnique;
+
+
+ /** indicates that the index is used for the primary key.
+ */
+ [readonly, property] boolean IsPrimaryKeyIndex;
+
+
+ /** indicates that the index is clustered.
+ */
+ [readonly, property] boolean IsClustered;
+};
+
+
+}; }; }; };
+
+/*===========================================================================
+===========================================================================*/
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */