summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/sdb/QueryDescriptor.idl
diff options
context:
space:
mode:
Diffstat (limited to 'offapi/com/sun/star/sdb/QueryDescriptor.idl')
-rw-r--r--offapi/com/sun/star/sdb/QueryDescriptor.idl162
1 files changed, 162 insertions, 0 deletions
diff --git a/offapi/com/sun/star/sdb/QueryDescriptor.idl b/offapi/com/sun/star/sdb/QueryDescriptor.idl
new file mode 100644
index 000000000000..7c3c86b22e6d
--- /dev/null
+++ b/offapi/com/sun/star/sdb/QueryDescriptor.idl
@@ -0,0 +1,162 @@
+/*************************************************************************
+ *
+ * $RCSfile: QueryDescriptor.idl,v $
+ *
+ * $Revision: 1.1 $
+ *
+ * last change: $Author: mi $ $Date: 2000-11-06 09:21:54 $
+ *
+ * The Contents of this file are made available subject to the terms of
+ * either of the following licenses
+ *
+ * - GNU Lesser General Public License Version 2.1
+ * - Sun Industry Standards Source License Version 1.1
+ *
+ * Sun Microsystems Inc., October, 2000
+ *
+ * GNU Lesser General Public License Version 2.1
+ * =============================================
+ * Copyright 2000 by Sun Microsystems, Inc.
+ * 901 San Antonio Road, Palo Alto, CA 94303, USA
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License version 2.1, as published by the Free Software Foundation.
+ *
+ * This library 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 for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
+ * MA 02111-1307 USA
+ *
+ *
+ * Sun Industry Standards Source License Version 1.1
+ * =================================================
+ * The contents of this file are subject to the Sun Industry Standards
+ * Source License Version 1.1 (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.openoffice.org/license.html.
+ *
+ * Software provided under this License is provided on an "AS IS" basis,
+ * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
+ * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
+ * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
+ * See the License for the specific provisions governing your rights and
+ * obligations concerning the Software.
+ *
+ * The Initial Developer of the Original Code is: Sun Microsystems, Inc.
+ *
+ * Copyright: 2000 by Sun Microsystems, Inc.
+ *
+ * All Rights Reserved.
+ *
+ * Contributor(s): _______________________________________
+ *
+ *
+ ************************************************************************/
+#ifndef __com_sun_star_sdb_QueryDescriptor_idl__
+#define __com_sun_star_sdb_QueryDescriptor_idl__
+
+#ifndef __com_sun_star_sdbcx_Descriptor_idl__
+#include <com/sun/star/sdbcx/Descriptor.idl>
+#endif
+
+ module com { module sun { module star { module sdbcx {
+interface XDataDescriptorFactory;
+interface XColumnsSupplier;
+};};};};
+
+#ifndef __com_sun_star_sdb_DataSettings_idl__
+#include <com/sun/star/sdb/DataSettings.idl>
+#endif
+
+ module com { module sun { module star { module sdb {
+
+
+// DocMerge from xml: service com::sun::star::sdbcx::com::sun::star::sdb::QueryDescriptor
+/** A query is a stored definition of a SQL "Select statement".
+
+ <p>It can be used, if there is a need to execute SQL statement more than once or
+ if you want to format the query result fields different from the
+ underlying table definitions.</p>
+ */
+service QueryDescriptor
+{
+ // DocMerge: empty anyway
+ service com::sun::star::sdbcx::Descriptor;
+
+
+ // DocMerge from xml: service com::sun::star::sdbcx::com::sun::star::sdb::QueryDescriptor: interface com::sun::star::sdbcx::XDataDescriptorFactory
+ /** is provided for creation of a new query descriptor based on the current informations.
+ */
+ interface com::sun::star::sdbcx::XDataDescriptorFactory;
+
+
+ // DocMerge from xml: service com::sun::star::sdbcx::com::sun::star::sdb::QueryDescriptor: service com::sun::star::sdb::DataSettings
+ /** is used for customization of data appearance.
+ */
+ service com::sun::star::sdb::DataSettings;
+
+
+ // DocMerge from xml: service com::sun::star::sdbcx::com::sun::star::sdb::QueryDescriptor: interface com::sun::star::sdbcx::XColumnsSupplier
+ /** access to the columns of the results sets query.
+ */
+ interface com::sun::star::sdbcx::XColumnsSupplier;
+
+
+ // DocMerge from xml: property com::sun::star::sdbcx::com::sun::star::sdb::QueryDescriptor::Command
+ /** is the command of the query, this is typically a select statement.
+ */
+ [property] string Command;
+
+
+ // DocMerge from xml: property com::sun::star::sdbcx::com::sun::star::sdb::QueryDescriptor::EscapeProcessing
+ /** should we use escape processing for the query.
+ */
+ [property] boolean EscapeProcessing;
+
+
+ // DocMerge from xml: property com::sun::star::sdbcx::com::sun::star::sdb::QueryDescriptor::UpdateTableName
+ /** is the name of the table which should be updated, this is usually used
+ for queries which relate on more than one table.
+ */
+ [property] string UpdateTableName;
+
+
+ // DocMerge from xml: property com::sun::star::sdbcx::com::sun::star::sdb::QueryDescriptor::UpdateCatalogName
+ /** is the name of the update table catalog.
+ */
+ [property] string UpdateCatalogName;
+
+
+ // DocMerge from xml: property com::sun::star::sdbcx::com::sun::star::sdb::QueryDescriptor::UpdateSchemaName
+ /** is the name of the update table schema.
+ */
+ [property] string UpdateSchemaName;
+};
+
+//=============================================================================
+
+}; }; }; };
+
+/*===========================================================================
+ $Log: not supported by cvs2svn $
+ Revision 1.1.1.1 2000/09/18 23:35:37 hjs
+ initial import
+
+ Revision 1.4 2000/09/11 11:52:39 mi
+ documentation merged from XML
+
+ Revision 1.2 2000/06/05 13:35:37 dg
+ services changed
+
+ Revision 1.1 2000/06/05 13:19:53 dg
+ new services
+
+
+===========================================================================*/
+#endif