summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/sdbc/XSQLData.idl
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--offapi/com/sun/star/sdbc/XSQLData.idl133
1 files changed, 133 insertions, 0 deletions
diff --git a/offapi/com/sun/star/sdbc/XSQLData.idl b/offapi/com/sun/star/sdbc/XSQLData.idl
new file mode 100644
index 000000000..b187437d3
--- /dev/null
+++ b/offapi/com/sun/star/sdbc/XSQLData.idl
@@ -0,0 +1,133 @@
+/* -*- 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_XSQLData_idl__
+#define __com_sun_star_sdbc_XSQLData_idl__
+
+#include <com/sun/star/uno/XInterface.idl>
+
+#include <com/sun/star/sdbc/SQLException.idl>
+
+ module com { module sun { module star { module sdbc {
+
+ published interface XSQLInput;
+ published interface XSQLOutput;
+
+
+/** is used for the custom mapping of SQL user-defined types.
+
+
+ <p>
+ This interface must be implemented by a service that is
+ registered in a type mapping. It is expected that this interface
+ will normally be implemented by a tool. The methods in this interface
+ are called by the driver and are never called by a programmer
+ directly.
+ </p>
+ */
+published interface XSQLData: com::sun::star::uno::XInterface
+{
+
+ /** returns the fully-qualified name of the SQL user-defined type
+ that this object represents.
+
+
+ <p>
+ This method is called by the SDBC driver to get the name of the
+ UDT instance that is being mapped to this instance of SQLData.
+ </p>
+ @returns
+ the name of the SQL type.
+ @throws SQLException
+ if a database access error occurs.
+ */
+ string getSQLTypeName() raises (SQLException);
+
+
+ /** populates this object with data read from the database.
+
+
+ <p>
+ The implementation of the method must follow this protocol:
+ <br/>
+ It must read each of the attributes or elements of the SQL
+ type from the given input stream. This is done
+ by calling a method of the input stream to read each
+ item, in the order that they appear in the SQL definition
+ of the type. The method
+ <code>readSQL</code>
+ then assigns the data to appropriate fields or elements (of this
+ or other objects).
+ <br/>
+ Specifically, it must call the appropriate
+ <code>XSQLInput.readXXX</code>
+ method(s) to do the following:
+ for a Distinct Type, read its single data element;
+ for a Structured Type, read a value for each attribute of the SQL type.
+ </p>
+ <p>
+ The SDBC driver initializes the input stream with a type map
+ before calling this method, which is used by the appropriate
+ <code>SQLInput.readXXX</code>
+ method on the stream.
+ </p>
+
+ @param stream
+ the input SQL data stream
+ @param typeName
+ the SQL type of the value on the data stream
+ @throws SQLException
+ if a database access error occurs.
+
+ @see com::sun::star::sdbc::XSQLInput
+ */
+ void readSQL([in]XSQLInput stream, [in]string typeName)
+ raises (SQLException);
+
+ /** writes this object to the given SQL data stream.
+
+
+ <p>
+ The implementation of the method must follow this protocol:
+ <br/>
+ It must write each of the attributes of the SQL type to the given output
+ stream. This is done by calling a method of the output stream to write
+ each item, in the order that they appear in the SQL definition of the type.
+ Specifically, it must call the appropriate
+ <code>XSQLOutput.writeXXX</code>
+ method(s) to do the following:<br>
+ for a Distinct Type, write its single data element;
+ for a Structured Type, write a value for each attribute of the SQL type.
+ </p>
+ @param stream
+ the output SQL data stream
+ @throws SQLException
+ if a database access error occurs.
+ @see com::sun::star::sdbc::XSQLOutput
+ */
+ void writeSQL([in]XSQLOutput stream) raises (SQLException);
+};
+
+
+}; }; }; };
+
+/*===========================================================================
+===========================================================================*/
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */