diff options
Diffstat (limited to 'offapi/com/sun/star/sdbc')
63 files changed, 12346 insertions, 0 deletions
diff --git a/offapi/com/sun/star/sdbc/BatchUpdateException.idl b/offapi/com/sun/star/sdbc/BatchUpdateException.idl new file mode 100644 index 000000000000..d848580f93c8 --- /dev/null +++ b/offapi/com/sun/star/sdbc/BatchUpdateException.idl @@ -0,0 +1,110 @@ +/************************************************************************* + * + * $RCSfile: BatchUpdateException.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:57 $ + * + * 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_sdbc_BatchUpdateException_idl__ +#define __com_sun_star_sdbc_BatchUpdateException_idl__ + +#ifndef __com_sun_star_sdbc_SQLException_idl__ +#include <com/sun/star/sdbc/SQLException.idl> +#endif + + module com { module sun { module star { module sdbc { + + +// DocMerge from xml: exception com::sun::star::sdbc::BatchUpdateException +/** is thrown when an error occurs during a batch update operation. + + + <p>In addition to the information provided by + <type scope="com::sun::star::sdbc">SQLException</type>}, a + <code>BatchUpdateException</code> provides the update counts for all commands + that were executed successfully during the batch update, that is, all commands + that were executed before the error occurred. The order of elements in an + array of update counts corresponds to the order in which commands were added + to the batch.</p> + */ +exception BatchUpdateException: SQLException +{ + + // DocMerge from idl: field com::sun::star::sdbc::BatchUpdateException::UpdateCounts + /** is an array of <code>long</code>, with each element + indicating the update count for a SQL command that executed + successfully before the exception was thrown. + */ + sequence<long> UpdateCounts; +}; + +//============================================================================= + +}; }; }; }; + +/*=========================================================================== + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:38 hjs + initial import + + Revision 1.3 2000/09/11 11:52:41 mi + documentation merged from XML + + Revision 1.1 1999/11/24 08:40:58 dg + new StarDataBaseConnectivity + +===========================================================================*/ +#endif diff --git a/offapi/com/sun/star/sdbc/BestRowScope.idl b/offapi/com/sun/star/sdbc/BestRowScope.idl new file mode 100644 index 000000000000..209f18f8942d --- /dev/null +++ b/offapi/com/sun/star/sdbc/BestRowScope.idl @@ -0,0 +1,123 @@ +/************************************************************************* + * + * $RCSfile: BestRowScope.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:57 $ + * + * 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_sdbc_BestRowScope_idl__ +#define __com_sun_star_sdbc_BestRowScope_idl__ + + module com { module sun { module star { module sdbc { + + +// DocMerge from idl: constants com::sun::star::sdbc::BestRowScope +/** determines how long a row identifier is valid. + */ +constants BestRowScope +{ + + // DocMerge from idl: value com::sun::star::sdbc::BestRowScope::TEMPORARY + /** indicates that the scope of the best row identifier is + very temporary, lasting only while the + row is being used. + A possible value for the column + <code>SCOPE</code> + in the <code>XResultSet</code> object + returned by the method <code>getBestRowIdentifier</code>. + */ + const long TEMPORARY = 0; + //------------------------------------------------------------------------- + + // DocMerge from idl: value com::sun::star::sdbc::BestRowScope::TRANSACTION + /** indicates that the scope of the best row identifier is + the remainder of the current transaction. + A possible value for the column + <code>SCOPE</code> + in the <code>XResultSet</code> object + returned by the method <code>getBestRowIdentifier</code>. + */ + const long TRANSACTION = 1; + //------------------------------------------------------------------------- + + // DocMerge from idl: value com::sun::star::sdbc::BestRowScope::SESSION + /** indicates that the scope of the best row identifier is + the remainder of the current session. + A possible value for the column + <code>SCOPE</code> + in the <code>XResultSet</code> object + returned by the method <code>getBestRowIdentifier</code>. + */ + const long SESSION = 2; +}; + +//============================================================================= + +}; }; }; }; + +/*=========================================================================== + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:38 hjs + initial import + + Revision 1.3 2000/09/11 11:52:41 mi + documentation merged from XML + + Revision 1.1 1999/11/24 08:40:58 dg + new StarDataBaseConnectivity + +===========================================================================*/ +#endif diff --git a/offapi/com/sun/star/sdbc/BestRowType.idl b/offapi/com/sun/star/sdbc/BestRowType.idl new file mode 100644 index 000000000000..275587e11d6b --- /dev/null +++ b/offapi/com/sun/star/sdbc/BestRowType.idl @@ -0,0 +1,119 @@ +/************************************************************************* + * + * $RCSfile: BestRowType.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:57 $ + * + * 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_sdbc_BestRowType_idl__ +#define __com_sun_star_sdbc_BestRowType_idl__ + + module com { module sun { module star { module sdbc { + + +// DocMerge from idl: constants com::sun::star::sdbc::BestRowType +/** determines the type of the best row identifier. + */ +constants BestRowType +{ + + // DocMerge from idl: value com::sun::star::sdbc::BestRowType::UNKNOWN + /** indicates that the best row identifier may or may not be a pseudo column. + A possible value for the column + <code>PSEUDO_COLUMN</code> + in the <code>XResultSet</code> object + returned by the method <code>getBestRowIdentifier</code>. + */ + const long UNKNOWN = 0; + //------------------------------------------------------------------------- + + // DocMerge from idl: value com::sun::star::sdbc::BestRowType::NOT_PSEUDO + /** indicates that the best row identifier is NOT a pseudo column. + A possible value for the column + <code>PSEUDO_COLUMN</code> + in the <code>XResultSet</code> object + returned by the method <code>getBestRowIdentifier</code>. + */ + const long NOT_PSEUDO = 1; + //------------------------------------------------------------------------- + + // DocMerge from idl: value com::sun::star::sdbc::BestRowType::PSEUDO + /** indicates that the best row identifier is a pseudo column. + A possible value for the column + <code>PSEUDO_COLUMN</code> + in the <code>XResultSet</code> object + returned by the method <code>getBestRowIdentifier</code>. + */ + const long PSEUDO = 2; +}; + +//============================================================================= + +}; }; }; }; + +/*=========================================================================== + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:38 hjs + initial import + + Revision 1.3 2000/09/11 11:52:41 mi + documentation merged from XML + + Revision 1.1 1999/11/24 08:40:58 dg + new StarDataBaseConnectivity + +===========================================================================*/ +#endif diff --git a/offapi/com/sun/star/sdbc/CallableStatement.idl b/offapi/com/sun/star/sdbc/CallableStatement.idl new file mode 100644 index 000000000000..98820e31c2a3 --- /dev/null +++ b/offapi/com/sun/star/sdbc/CallableStatement.idl @@ -0,0 +1,142 @@ +/************************************************************************* + * + * $RCSfile: CallableStatement.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:57 $ + * + * 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_sdbc_CallableStatement_idl__ +#define __com_sun_star_sdbc_CallableStatement_idl__ + +#ifndef __com_sun_star_sdbc_PreparedStatement_idl__ +#include <com/sun/star/sdbc/PreparedStatement.idl> +#endif + + module com { module sun { module star { module sdbc { + +interface XRow; +interface XOutParameters; + + +// DocMerge from xml: service com::sun::star::sdbc::CallableStatement +/** is used to execute SQL stored procedures. + + + <p>SDBC provides a stored procedure SQL escape that allows stored procedures + to be called in a standard way for all RDBMSs. This escape syntax has one + form that includes a result parameter and one that does not. If used, the + result parameter must be registered as an OUT parameter. The other parameters + can be used for input, output or both. Parameters are referred to sequentially, + by number. The first parameter is 1. + </p> + <p> + <code> + {?= call &lt;procedure-name&gt;[&lt;arg1&gt;,&lt;arg2&gt;, ...]} + {call &lt;procedure-name&gt;[&lt;arg1&gt;,&lt;arg2&gt;, ...]} + </code> + </p> + <p>IN parameter values are set using the set methods inherited from + <type scope="com::sun::star::sdbc">PreparedStatement</type>. The type of all + OUT parameters must be registered prior to executing the stored procedure; + their values are retrieved after execution via the <code>get</code> methods + provided by the <type scope="com::sun::star::sdbc">XRow</type>.</p> + <p>A <code>CallableStatement</code> can return one + <type scope="com::sun::star::sdbc">XResultSet</type> or multiple + <code>ResultSet</code> objects. Multiple <code>ResultSet</code> objects are + handled using operations inherited from + <type scope="com::sun::star::sdbc">XPreparedStatement</type>.</p> + <p>For maximum portability, a call's <code>ResultSet</code> objects and + update counts should be processed prior to getting the values of output + parameters.</p> + */ +service CallableStatement +{ + // DocMerge: empty anyway + service PreparedStatement; + + + // DocMerge from xml: service com::sun::star::sdbc::CallableStatement: interface com::sun::star::sdbc::XRow + /** is used for retrieve the values of OUT parameters. + */ + interface XRow; + + + // DocMerge from xml: service com::sun::star::sdbc::CallableStatement: interface com::sun::star::sdbc::XOutParameters + /** is used to declare parameters as OUT parameters. + */ + interface XOutParameters; +}; + +//============================================================================= + +}; }; }; }; + +/*=========================================================================== + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:39 hjs + initial import + + Revision 1.4 2000/09/11 11:52:41 mi + documentation merged from XML + + Revision 1.2 1999/11/30 13:42:56 hr + #65293#: typo + + Revision 1.1 1999/11/24 08:40:58 dg + new StarDataBaseConnectivity + +===========================================================================*/ +#endif diff --git a/offapi/com/sun/star/sdbc/ChangeAction.idl b/offapi/com/sun/star/sdbc/ChangeAction.idl new file mode 100644 index 000000000000..b242fc027dfe --- /dev/null +++ b/offapi/com/sun/star/sdbc/ChangeAction.idl @@ -0,0 +1,95 @@ +/************************************************************************* + * + * $RCSfile: ChangeAction.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:57 $ + * + * 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_sdbc_ChangeAction_idl__ +#define __com_sun_star_sdbc_ChangeAction_idl__ + +module com { module sun { module star { module sdbc { + +/** determines the type of the change which is going to be performed. +*/ +constants ChangeAction +{ + /** + indicates that a insert will be performed. + */ + const long INSERT = 1; + //------------------------------------------------------------------------- + /** + indicates that a update will be performed. + */ + const long UPDATE = 2; + //------------------------------------------------------------------------- + /** + indicates that a delete will be performed. + */ + const long DELETE = 3; + //------------------------------------------------------------------------- + /** + indicates that a undo will be performed. + */ + const long UNDO = 4; +}; + +//============================================================================= + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/sdbc/ChangeEvent.idl b/offapi/com/sun/star/sdbc/ChangeEvent.idl new file mode 100644 index 000000000000..b5e1f2e0cdbc --- /dev/null +++ b/offapi/com/sun/star/sdbc/ChangeEvent.idl @@ -0,0 +1,87 @@ +/************************************************************************* + * + * $RCSfile: ChangeEvent.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:57 $ + * + * 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_sdbc_ChangeEvent_idl__ +#define __com_sun_star_sdbc_ChangeEvent_idl__ + +#ifndef __com_sun_star_lang_EventObject_idl__ +#include <com/sun/star/lang/EventObject.idl> +#endif + +module com { module sun { module star { module sdbc { + +/** indicates the type of change action on the data source. +*/ +struct ChangeEvent : com::sun::star::lang::EventObject +{ + /** indicates the type of change. + @see com::sun::star::sdbc::ChangeAction + */ + long Action; + + /** indicates the number of rows affectd by the change. */ + long Rows; +}; + +//============================================================================= + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/sdbc/ColumnSearch.idl b/offapi/com/sun/star/sdbc/ColumnSearch.idl new file mode 100644 index 000000000000..c121f7a694ba --- /dev/null +++ b/offapi/com/sun/star/sdbc/ColumnSearch.idl @@ -0,0 +1,130 @@ +/************************************************************************* + * + * $RCSfile: ColumnSearch.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:57 $ + * + * 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_sdbc_ColumnSearch_idl__ +#define __com_sun_star_sdbc_ColumnSearch_idl__ + + module com { module sun { module star { module sdbc { + + +// DocMerge from idl: constants com::sun::star::sdbc::ColumnSearch +/** indicates in which way a column can be used in the WHERE search. + */ +constants ColumnSearch +{ + //------------------------------------------------------------------------- + + // DocMerge from idl: value com::sun::star::sdbc::ColumnSearch::NONE + /** A possible value for column <code>SEARCHABLE</code> in the + <code>XResultSet</code> object returned by the method + <code>getTypeInfo</code>. + <p>Indicates that <code>WHERE</code> search clauses are not supported + for this type. + */ + const long NONE = 0; + //------------------------------------------------------------------------- + + // DocMerge from idl: value com::sun::star::sdbc::ColumnSearch::CHAR + /** A possible value for column <code>SEARCHABLE</code> in the + <code>XResultSet</code> object returned by the method + <code>getTypeInfo</code>. + <p>Indicates that the only <code>WHERE</code> search clause that can + be based on this type is <code>WHERE . . .LIKE</code>. + */ + const long CHAR = 1; + //------------------------------------------------------------------------- + + // DocMerge from idl: value com::sun::star::sdbc::ColumnSearch::BASIC + /** A possible value for column <code>SEARCHABLE</code> in the + <code>XResultSet</code> object returned by the method + <code>getTypeInfo</code>. + <p>Indicates that one can base all <code>WHERE</code> search clauses + except <code>WHERE . . .LIKE</code> on this data type. + */ + const long BASIC = 2; + //------------------------------------------------------------------------- + + // DocMerge from idl: value com::sun::star::sdbc::ColumnSearch::FULL + /** A possible value for column <code>SEARCHABLE</code> in the + <code>XResultSet</code> object returned by the method + <code>getTypeInfo</code>. + <p>Indicates that all <code>WHERE</code> search clauses can be + based on this type. + */ + const long FULL = 3; +}; + +//============================================================================= + +}; }; }; }; + +/*=========================================================================== + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:39 hjs + initial import + + Revision 1.3 2000/09/11 11:52:41 mi + documentation merged from XML + + Revision 1.1 1999/11/24 08:40:59 dg + new StarDataBaseConnectivity + +===========================================================================*/ +#endif diff --git a/offapi/com/sun/star/sdbc/ColumnType.idl b/offapi/com/sun/star/sdbc/ColumnType.idl new file mode 100644 index 000000000000..45e69ed64828 --- /dev/null +++ b/offapi/com/sun/star/sdbc/ColumnType.idl @@ -0,0 +1,119 @@ +/************************************************************************* + * + * $RCSfile: ColumnType.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:57 $ + * + * 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_sdbc_ColumnType_idl__ +#define __com_sun_star_sdbc_ColumnType_idl__ + + module com { module sun { module star { module sdbc { + + +// DocMerge from idl: constants com::sun::star::sdbc::ColumnType +/** determines the type of a version column. + */ +constants ColumnType +{ + + // DocMerge from idl: value com::sun::star::sdbc::ColumnType::UNKNOWN + /** indicates that this column may or may not be a pseudo column. + A possible value for the column + <code>PSEUDO_COLUMN</code> + in the <code>XResultSet</code> object + returned by the method <code>getVersionColumns</code>. + */ + const long UNKNOWN = 0; + //------------------------------------------------------------------------- + + // DocMerge from idl: value com::sun::star::sdbc::ColumnType::NOT_PSEUDO + /** indicates that this column is NOT a pseudo column. + A possible value for the column + <code>PSEUDO_COLUMN</code> + in the <code>XResultSet</code> object + returned by the method <code>getVersionColumns</code>. + */ + const long NOT_PSEUDO = 1; + //------------------------------------------------------------------------- + + // DocMerge from idl: value com::sun::star::sdbc::ColumnType::PSEUDO + /** indicates that this column is a pseudo column. + A possible value for the column + <code>PSEUDO_COLUMN</code> + in the <code>XResultSet</code> object + returned by the method <code>getVersionColumns</code>. + */ + const long PSEUDO = 2; +}; + +//============================================================================= + +}; }; }; }; + +/*=========================================================================== + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:39 hjs + initial import + + Revision 1.3 2000/09/11 11:52:41 mi + documentation merged from XML + + Revision 1.1 1999/11/24 08:40:59 dg + new StarDataBaseConnectivity + +===========================================================================*/ +#endif diff --git a/offapi/com/sun/star/sdbc/ColumnValue.idl b/offapi/com/sun/star/sdbc/ColumnValue.idl new file mode 100644 index 000000000000..bbe9ce3b1580 --- /dev/null +++ b/offapi/com/sun/star/sdbc/ColumnValue.idl @@ -0,0 +1,105 @@ +/************************************************************************* + * + * $RCSfile: ColumnValue.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:57 $ + * + * 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_sdbc_ColumnValue_idl__ +#define __com_sun_star_sdbc_ColumnValue_idl__ + + module com { module sun { module star { module sdbc { + + +// DocMerge from idl: constants com::sun::star::sdbc::ColumnValue +/** determines whether a column allows SQL NULL values or not. + */ +constants ColumnValue +{ + + // DocMerge from idl: value com::sun::star::sdbc::ColumnValue::NO_NULLS + /** indicates that a column does not allow NULL values. + */ + const long NO_NULLS = 0; + + // DocMerge from idl: value com::sun::star::sdbc::ColumnValue::NULLABLE + /** indicates that a column does allow NULL values. + */ + const long NULLABLE = 1; + + // DocMerge from idl: value com::sun::star::sdbc::ColumnValue::NULLABLE_UNKNOWN + /** indicates that the nullability of the column is unknown. + */ + const long NULLABLE_UNKNOWN = 2; +}; + +//============================================================================= + +}; }; }; }; + +/*=========================================================================== + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:39 hjs + initial import + + Revision 1.3 2000/09/11 11:52:41 mi + documentation merged from XML + + Revision 1.1 1999/11/24 08:40:59 dg + new StarDataBaseConnectivity + +===========================================================================*/ +#endif diff --git a/offapi/com/sun/star/sdbc/Connection.idl b/offapi/com/sun/star/sdbc/Connection.idl new file mode 100644 index 000000000000..2f1a6bc33a25 --- /dev/null +++ b/offapi/com/sun/star/sdbc/Connection.idl @@ -0,0 +1,136 @@ +/************************************************************************* + * + * $RCSfile: Connection.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:57 $ + * + * 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_sdbc_Connection_idl__ +#define __com_sun_star_sdbc_Connection_idl__ + +#ifndef __com_sun_star_lang_XComponent_idl__ +#include <com/sun/star/lang/XComponent.idl> +#endif + + module com { module sun { module star { module sdbc { + +interface XConnection; +interface XWarningsSupplier; + + +// DocMerge from xml: service com::sun::star::sdbc::Connection +/** represents a connection (session) with a specific + database. Within the context of a Connection, SQL statements are + executed and results are returned. + + + + <p>A Connection's database is able to provide information + describing its tables, its supported SQL grammar, its stored + procedures, and the capabilities of this connection. This + information is obtained with the <code>getMetaData</code> method. + + </p> + <p> + <b>Note:</b> By default the Connection automatically commits + changes after executing each statement. If auto commit has been + disabled, an explicit commit must be done or database changes will + not be saved. + + </p>@see com::sun::star::sdbc::XStatement + @see com::sun::star::sdbc::XResultSet + @see com::sun::star::sdbc::XDatabaseMetaData + */ +service Connection +{ + + // DocMerge from xml: service com::sun::star::sdbc::Connection: interface com::sun::star::lang::XComponent + /** controls the closing of a connection. + */ + interface com::sun::star::lang::XComponent; + + + // DocMerge from xml: service com::sun::star::sdbc::Connection: interface com::sun::star::sdbc::XConnection + /** the main interface for interaction with a connection to a database. + */ + interface XConnection; + + + // DocMerge from xml: service com::sun::star::sdbc::Connection: interface com::sun::star::sdbc::XWarningsSupplier + /** controls the chaining of warnings, which may occur on every call + to the connected database. Chained warnings from previous calls will be + cleared before processing a new call. + */ + interface XWarningsSupplier; +}; + +//============================================================================= + +}; }; }; }; + +/*=========================================================================== + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:39 hjs + initial import + + Revision 1.3 2000/09/11 11:52:41 mi + documentation merged from XML + + Revision 1.1 1999/11/24 08:40:59 dg + new StarDataBaseConnectivity + +===========================================================================*/ +#endif diff --git a/offapi/com/sun/star/sdbc/DataTruncation.idl b/offapi/com/sun/star/sdbc/DataTruncation.idl new file mode 100644 index 000000000000..4938ae174c17 --- /dev/null +++ b/offapi/com/sun/star/sdbc/DataTruncation.idl @@ -0,0 +1,133 @@ +/************************************************************************* + * + * $RCSfile: DataTruncation.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:57 $ + * + * 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_sdbc_DataTruncation_idl__ +#define __com_sun_star_sdbc_DataTruncation_idl__ + +#ifndef __com_sun_star_sdbc_SQLWarning_idl__ +#include <com/sun/star/sdbc/SQLWarning.idl> +#endif + + module com { module sun { module star { module sdbc { + + +// DocMerge from xml: exception com::sun::star::sdbc::DataTruncation +/** reports a DataTruncation warning, on reads, or is thrown as a DataTruncation exception, + on writes, when a data value is unexpectedly truncated. + + + + <p>The SQLstate for a <code>DataTruncation</code> is <code>01004</code>.</p> + */ +exception DataTruncation: SQLWarning +{ + + // DocMerge from xml: field com::sun::star::sdbc::DataTruncation::Index + /** is the index of the parameter or column value. + */ + long Index; + + + // DocMerge from xml: field com::sun::star::sdbc::DataTruncation::IsParameter + /** is <true></true> if a parameter value is truncated. + */ + boolean IsParameter; + + + // DocMerge from xml: field com::sun::star::sdbc::DataTruncation::DuringRead + /** is <true></true> if a read was truncated. + */ + boolean DuringRead; + + + // DocMerge from xml: field com::sun::star::sdbc::DataTruncation::DataSize + /** contains the number of bytes of data that should have been transferred. + This number may be approximate if data conversions were being + performed. The value may be <code>-1</code> if the size is unknown. + */ + long DataSize; + + + // DocMerge from xml: field com::sun::star::sdbc::DataTruncation::TransferSize + /** contains the number of bytes of data actually transferred. + The value may be <code>-1</code> if the size is unknown. + */ + long TransferSize; +}; + +//============================================================================= + +}; }; }; }; +/*=========================================================================== + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:39 hjs + initial import + + Revision 1.4 2000/09/11 11:52:41 mi + documentation merged from XML + + Revision 1.2 1999/12/13 13:47:54 dg + #70278# XSQLErrorBroadcaster removed + + Revision 1.1 1999/11/24 08:41:00 dg + new StarDataBaseConnectivity + +===========================================================================*/ +#endif diff --git a/offapi/com/sun/star/sdbc/DataType.idl b/offapi/com/sun/star/sdbc/DataType.idl new file mode 100644 index 000000000000..3101584befc3 --- /dev/null +++ b/offapi/com/sun/star/sdbc/DataType.idl @@ -0,0 +1,208 @@ +/************************************************************************* + * + * $RCSfile: DataType.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:57 $ + * + * 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_sdbc_DataType_idl__ +#define __com_sun_star_sdbc_DataType_idl__ + + module com { module sun { module star { module sdbc { + + +// DocMerge from idl: constants com::sun::star::sdbc::DataType +/** These constants are used to specify database data types which are used + to identify the generic SQL types. The definition is based on JDBC 2.0. + + <p>The actual type constant values are equivalent to those in the X/Open CLI. + */ +constants DataType +{ + // DocMerge: empty anyway + const long BIT = -7; + + // DocMerge: empty anyway + const long TINYINT = -6; + + // DocMerge: empty anyway + const long SMALLINT = 5; + + // DocMerge: empty anyway + const long INTEGER = 4; + + // DocMerge: empty anyway + const long BIGINT = -5; + + // DocMerge: empty anyway + const long FLOAT = 6; + + // DocMerge: empty anyway + const long REAL = 7; + + // DocMerge: empty anyway + const long DOUBLE = 8; + + // DocMerge: empty anyway + const long NUMERIC = 2; + + // DocMerge: empty anyway + const long DECIMAL = 3; + + // DocMerge: empty anyway + const long CHAR = 1; + + // DocMerge: empty anyway + const long VARCHAR = 12; + + // DocMerge: empty anyway + const long LONGVARCHAR = -1; + + // DocMerge: empty anyway + const long DATE = 91; + + // DocMerge: empty anyway + const long TIME = 92; + + // DocMerge: empty anyway + const long TIMESTAMP = 93; + + // DocMerge: empty anyway + const long BINARY = -2; + + // DocMerge: empty anyway + const long VARBINARY = -3; + + // DocMerge: empty anyway + const long LONGVARBINARY = -4; + + // DocMerge: empty anyway + const long SQLNULL = 0; + + + // DocMerge from idl: value com::sun::star::sdbc::DataType::OTHER + /** indicates that the SQL type is database-specific and + gets mapped to an object that can be accessed via + the method <member scope="com::sun::star::sql">XGetData::getObject()</member>. + */ + const long OTHER = 1111; + + + // DocMerge from idl: value com::sun::star::sdbc::DataType::OBJECT + /** indicates a type which is represented by an object which implements + this type. + */ + const long OBJECT = 2000; + + + // DocMerge from idl: value com::sun::star::sdbc::DataType::DISTINCT + /** describes a type based on a built-in type. + It is a user-defined data type (UDT). + */ + const long DISTINCT = 2001; + + + // DocMerge from idl: value com::sun::star::sdbc::DataType::STRUCT + /** indicates a type consisting of attributes that may be any type. + It is a user-defined data type (UDT). + */ + const long STRUCT = 2002; + + + // DocMerge from idl: value com::sun::star::sdbc::DataType::ARRAY + /** indicates a type representing an SQL ARRAY. + */ + const long ARRAY = 2003; + + + // DocMerge from idl: value com::sun::star::sdbc::DataType::BLOB + /** indicates a type representing an SQL Binary Large Object. + */ + const long BLOB = 2004; + + + // DocMerge from idl: value com::sun::star::sdbc::DataType::CLOB + /** indicates a type representing an SQL Character Large Object. + */ + const long CLOB = 2005; + + + // DocMerge from idl: value com::sun::star::sdbc::DataType::REF + /** indicates a type representing an SQL REF, a referencing type. + */ + const long REF = 2006; +}; + +//============================================================================= + +}; }; }; }; + +/*=========================================================================== + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:39 hjs + initial import + + Revision 1.4 2000/09/11 11:52:42 mi + documentation merged from XML + + Revision 1.2 2000/03/01 11:49:51 fs + #73730# DataType_NULL => DataType_SQLNULL + + Revision 1.1 1999/11/24 08:41:00 dg + new StarDataBaseConnectivity + +===========================================================================*/ +#endif diff --git a/offapi/com/sun/star/sdbc/Deferrability.idl b/offapi/com/sun/star/sdbc/Deferrability.idl new file mode 100644 index 000000000000..b575e599ae82 --- /dev/null +++ b/offapi/com/sun/star/sdbc/Deferrability.idl @@ -0,0 +1,122 @@ +/************************************************************************* + * + * $RCSfile: Deferrability.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:57 $ + * + * 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_sdbc_Deferrability_idl__ +#define __com_sun_star_sdbc_Deferrability_idl__ + + module com { module sun { module star { module sdbc { + + +// DocMerge from idl: constants com::sun::star::sdbc::Deferrability +/** indicates the Deferrability of key constraints. + */ +constants Deferrability +{ + + // DocMerge from idl: value com::sun::star::sdbc::Deferrability::INITIALLY_DEFERRED + /** A possible value for the column <code>DEFERRABILITY</code> + in the + <code>XResultSet</code> objects returned by the methods + <code>getImportedKeys</code>, <code>getExportedKeys</code>, + and <code>getCrossReference</code>. + <P>Indicates deferrability. See SQL-92 for a definition. + */ + const long INITIALLY_DEFERRED = 5; + //------------------------------------------------------------------------- + + // DocMerge from idl: value com::sun::star::sdbc::Deferrability::INITIALLY_IMMEDIATE + /** A possible value for the column <code>DEFERRABILITY</code> + in the + <code>XResultSet</code> objects returned by the methods + <code>getImportedKeys</code>, <code>getExportedKeys</code>, + and <code>getCrossReference</code>. + <P>Indicates deferrability. See SQL-92 for a definition. + */ + const long INITIALLY_IMMEDIATE = 6; + //------------------------------------------------------------------------- + + // DocMerge from idl: value com::sun::star::sdbc::Deferrability::NONE + /** A possible value for the column <code>DEFERRABILITY</code> + in the + <code>XResultSet</code> objects returned by the methods + <code>getImportedKeys</code>, <code>getExportedKeys</code>, + and <code>getCrossReference</code>. + <P>Indicates deferrability. See SQL-92 for a definition. + */ + const long NONE = 7; +}; + +//============================================================================= + +}; }; }; }; + +/*=========================================================================== + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:39 hjs + initial import + + Revision 1.3 2000/09/11 11:52:42 mi + documentation merged from XML + + Revision 1.1 1999/11/24 08:41:00 dg + new StarDataBaseConnectivity + +===========================================================================*/ +#endif diff --git a/offapi/com/sun/star/sdbc/Driver.idl b/offapi/com/sun/star/sdbc/Driver.idl new file mode 100644 index 000000000000..87425085a8e4 --- /dev/null +++ b/offapi/com/sun/star/sdbc/Driver.idl @@ -0,0 +1,118 @@ +/************************************************************************* + * + * $RCSfile: Driver.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:57 $ + * + * 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_sdbc_Driver_idl__ +#define __com_sun_star_sdbc_Driver_idl__ + + module com { module sun { module star { module sdbc { + +interface XDriver; + + +// DocMerge from xml: service com::sun::star::sdbc::Driver +/** is the service that every driver class must implement. + + + + <p>Each driver should supply a service that implements + the Driver interface. + + </p> + <p>The DriverManager will try to load as many drivers as it can + find and then for any given connection request, it will ask each + driver in turn to try to connect to the target URL. + + </p> + <p>It is strongly recommended that each Driver object should be + small and standalone so that the Driver object can be loaded and + queried without bringing in vast quantities of supporting code. + + </p> + <p>Each driver should be a one instance service. + + </p>@see com::sun::star::sdbc::XDriverManager + @see com::sun::star::sdbc::XConnection + */ +service Driver +{ + + // DocMerge from xml: service com::sun::star::sdbc::Driver: interface com::sun::star::sdbc::XDriver + /** is the main interface to access a database driver. + */ + interface XDriver; +}; + +//============================================================================= + +}; }; }; }; + +/*=========================================================================== + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:39 hjs + initial import + + Revision 1.3 2000/09/11 11:52:42 mi + documentation merged from XML + + Revision 1.1 1999/11/24 08:41:00 dg + new StarDataBaseConnectivity + +===========================================================================*/ +#endif diff --git a/offapi/com/sun/star/sdbc/DriverManager.idl b/offapi/com/sun/star/sdbc/DriverManager.idl new file mode 100644 index 000000000000..e00bfea884d9 --- /dev/null +++ b/offapi/com/sun/star/sdbc/DriverManager.idl @@ -0,0 +1,120 @@ +/************************************************************************* + * + * $RCSfile: DriverManager.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:57 $ + * + * 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_sdbc_DriverManager_idl__ +#define __com_sun_star_sdbc_DriverManager_idl__ + +#ifndef __com_sun_star_container_XEnumerationAccess_idl__ +#include <com/sun/star/container/XEnumerationAccess.idl> +#endif + + module com { module sun { module star { module sdbc { + +interface XConnection; +interface XDriver; +interface XDriverManager; + + +// DocMerge from xml: service com::sun::star::sdbc::DriverManager +/** is the basic service for managing a set of SDBC drivers. + + + <p>As part of its initialization, the DriverManager service will + attempt to load the registered drivers. + + </p> + <p>When the method <code>getConnection</code> is called, + the DriverManager will attempt to + locate a suitable driver. + + </p>@see com::sun::star::sdbc::XDriver + @see com::sun::star::sdbc::XConnection + */ +service DriverManager +{ + + // DocMerge from xml: service com::sun::star::sdbc::DriverManager: interface com::sun::star::sdbc::XDriverManager + /** is the basic interface for establishing database connections. + */ + interface XDriverManager; + + // DocMerge from xml: service com::sun::star::sdbc::DriverManager: interface com::sun::star::container::XEnumerationAccess + /** creates an enumeration on all installed/ registered drivers. + */ + interface com::sun::star::container::XEnumerationAccess; +}; + +//============================================================================= + +}; }; }; }; + +/*=========================================================================== + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:39 hjs + initial import + + Revision 1.3 2000/09/11 11:52:42 mi + documentation merged from XML + + Revision 1.1 1999/11/24 08:41:00 dg + new StarDataBaseConnectivity + +===========================================================================*/ +#endif diff --git a/offapi/com/sun/star/sdbc/DriverPropertyInfo.idl b/offapi/com/sun/star/sdbc/DriverPropertyInfo.idl new file mode 100644 index 000000000000..530c79caae1d --- /dev/null +++ b/offapi/com/sun/star/sdbc/DriverPropertyInfo.idl @@ -0,0 +1,128 @@ +/************************************************************************* + * + * $RCSfile: DriverPropertyInfo.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:57 $ + * + * 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_sdbc_DriverPropertyInfo_idl__ +#define __com_sun_star_sdbc_DriverPropertyInfo_idl__ + + module com { module sun { module star { module sdbc { + + +// DocMerge from xml: struct com::sun::star::sdbc::DriverPropertyInfo +/** describes the driver properties for making a connection. + + + <p>The DriverPropertyInfo is of interest only to advanced programmers + who need to interact with a driver to discover and supply properties + for connections.</p> + */ +struct DriverPropertyInfo +{ + // DocMerge from xml: field com::sun::star::sdbc::DriverPropertyInfo::Name + /** is the name of the property. + */ + string Name; + + + // DocMerge from xml: field com::sun::star::sdbc::DriverPropertyInfo::Description + /** is a brief description of the property, which may be null. + */ + string Description; + + + // DocMerge from xml: field com::sun::star::sdbc::DriverPropertyInfo::IsRequired + /** is <true></true> if a value must be supplied for this property + during <code>Driver.connect</code> and <false></false> otherwise. + */ + boolean IsRequired; + + + // DocMerge from xml: field com::sun::star::sdbc::DriverPropertyInfo::Value + /** specifies the current value of the property, + based on the driver-supplied default values. This field + may be empty if no value is known. + */ + string Value; + + + // DocMerge from idl: field com::sun::star::sdbc::DriverPropertyInfo::Choices + /** contains a sequence of possible values if the value for the field + <code>DriverPropertyInfo.value</code> may be selected + from a particular set of values; otherwise empty. + */ + sequence<string> Choices; +}; + +//============================================================================= + +}; }; }; }; + +/*=========================================================================== + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:40 hjs + initial import + + Revision 1.3 2000/09/11 11:52:42 mi + documentation merged from XML + + Revision 1.1 1999/11/24 08:41:00 dg + new StarDataBaseConnectivity + +===========================================================================*/ +#endif diff --git a/offapi/com/sun/star/sdbc/FetchDirection.idl b/offapi/com/sun/star/sdbc/FetchDirection.idl new file mode 100644 index 000000000000..e46ee6449862 --- /dev/null +++ b/offapi/com/sun/star/sdbc/FetchDirection.idl @@ -0,0 +1,115 @@ +/************************************************************************* + * + * $RCSfile: FetchDirection.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:57 $ + * + * 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_sdbc_FetchDirection_idl__ +#define __com_sun_star_sdbc_FetchDirection_idl__ + + module com { module sun { module star { module sdbc { + + +// DocMerge from idl: constants com::sun::star::sdbc::FetchDirection +/** indicates in which direction a resultset should fetch next, just for + optimization. + */ +constants FetchDirection +{ + //------------------------------------------------------------------------- + + // DocMerge from idl: value com::sun::star::sdbc::FetchDirection::FORWARD + /** The rows in a result set will be processed in a forward direction; first-to-last. + */ + const long FORWARD = 1000; + //------------------------------------------------------------------------- + + // DocMerge from idl: value com::sun::star::sdbc::FetchDirection::REVERSE + /** The rows in a result set will be processed in a reverse direction; last-to-first. + */ + const long REVERSE = 1001; + //------------------------------------------------------------------------- + + // DocMerge from idl: value com::sun::star::sdbc::FetchDirection::UNKNOWN + /** The order in which rows in a result set will be processed is unknown: + */ + const long UNKNOWN = 1002; +}; + +//============================================================================= + +}; }; }; }; + +/*=========================================================================== + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:40 hjs + initial import + + Revision 1.4 2000/09/11 11:52:42 mi + documentation merged from XML + + Revision 1.2 1999/11/30 20:37:40 dg + #70248# wrong id's + + Revision 1.1 1999/11/30 20:20:51 dg + #70248# FetchDirchtion new + + Revision 1.1 1999/11/24 08:40:59 dg + new StarDataBaseConnectivity + +===========================================================================*/ +#endif diff --git a/offapi/com/sun/star/sdbc/IndexType.idl b/offapi/com/sun/star/sdbc/IndexType.idl new file mode 100644 index 000000000000..6864a0dc0f17 --- /dev/null +++ b/offapi/com/sun/star/sdbc/IndexType.idl @@ -0,0 +1,131 @@ +/************************************************************************* + * + * $RCSfile: IndexType.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:57 $ + * + * 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_sdbc_IndexType_idl__ +#define __com_sun_star_sdbc_IndexType_idl__ + + module com { module sun { module star { module sdbc { + + +// DocMerge from idl: constants com::sun::star::sdbc::IndexType +/** indicates the type of index. + */ +constants IndexType +{ + + // DocMerge from idl: value com::sun::star::sdbc::IndexType::STATISTIC + /** A possible value for column <code>TYPE</code> in the + <code>XResultSet</code> object returned by the method + <code>getIndexInfo</code>. + <P>Indentifies table statistics that are returned in conjunction + with a table's index description. + */ + const short STATISTIC = 0; + //------------------------------------------------------------------------- + + // DocMerge from idl: value com::sun::star::sdbc::IndexType::CLUSTERED + /** A possible value for column <code>TYPE</code> in the + <code>XResultSet</code> object returned by the method + <code>getIndexInfo</code>. + <P>Indicates that this table index is a clustered index. + */ + const short CLUSTERED = 1; + //------------------------------------------------------------------------- + + // DocMerge from idl: value com::sun::star::sdbc::IndexType::HASHED + /** A possible value for column <code>TYPE</code> in the + <code>XResultSet</code> object returned by the method + <code>getIndexInfo</code>. + <P>Indicates that this table index is a hashed index. + */ + const short HASHED = 2; + //------------------------------------------------------------------------- + + // DocMerge from idl: value com::sun::star::sdbc::IndexType::OTHER + /** A possible value for column <code>TYPE</code> in the + <code>XResultSet</code> object returned by the method + <code>getIndexInfo</code>. + <P>Indicates that this table index is not a clustered + index, a hashed index, or table statistics; + it is something other than these. + */ + const short OTHER = 3; +}; + +//============================================================================= + +}; }; }; }; + +/*=========================================================================== + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:40 hjs + initial import + + Revision 1.4 2000/09/11 11:52:42 mi + documentation merged from XML + + Revision 1.2 2000/06/05 09:47:53 dg + IndexType::Statistic was missing + + Revision 1.1 1999/11/24 08:41:01 dg + new StarDataBaseConnectivity + +===========================================================================*/ +#endif diff --git a/offapi/com/sun/star/sdbc/KeyRule.idl b/offapi/com/sun/star/sdbc/KeyRule.idl new file mode 100644 index 000000000000..53dca2c3c505 --- /dev/null +++ b/offapi/com/sun/star/sdbc/KeyRule.idl @@ -0,0 +1,167 @@ +/************************************************************************* + * + * $RCSfile: KeyRule.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:57 $ + * + * 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_sdbc_KeyRule_idl__ +#define __com_sun_star_sdbc_KeyRule_idl__ + + module com { module sun { module star { module sdbc { + + +// DocMerge from idl: constants com::sun::star::sdbc::KeyRule +/** determines the rules for foreign key constraints. + */ +constants KeyRule +{ + + // DocMerge from idl: value com::sun::star::sdbc::KeyRule::CASCADE + /** A possible value for the columns <code>UPDATE_RULE</code> + and <code>DELETE_RULE</code> in the + <code>XResultSet</code> objects returned by the methods + <code>getImportedKeys</code>, <code>getExportedKeys</code>, + and <code>getCrossReference</code>. + <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>For the column <code>DELETE_RULE</code>, + it indicates that + when the primary key is deleted, rows that imported that key + are deleted. + */ + const long CASCADE = 0; + //------------------------------------------------------------------------- + + // DocMerge from idl: value com::sun::star::sdbc::KeyRule::RESTRICT + /** A possible value for the columns <code>UPDATE_RULE</code> + and <code>DELETE_RULE</code> in the + <code>XResultSet</code> objects returned by the methods + <code>getImportedKeys</code>, <code>getExportedKeys</code>, + and <code>getCrossReference</code>. + <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>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. + */ + const long RESTRICT = 1; + //------------------------------------------------------------------------- + + // DocMerge from idl: value com::sun::star::sdbc::KeyRule::SET_NULL + /** A possible value for the columns <code>UPDATE_RULE</code> + and <code>DELETE_RULE</code> in the + <code>XResultSet</code> objects returned by the methods + <code>getImportedKeys</code>, <code>getExportedKeys</code>, + and <code>getCrossReference</code>. + <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>. + */ + const long SET_NULL = 2; + //------------------------------------------------------------------------- + + // DocMerge from idl: value com::sun::star::sdbc::KeyRule::NO_ACTION + /** A possible value for the columns <code>UPDATE_RULE</code> + and <code>DELETE_RULE</code> in the + <code>XResultSet</code> objects returned by the methods + <code>getImportedKeys</code>, <code>getExportedKeys</code>, + and <code>getCrossReference</code>. + <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. + */ + const long NO_ACTION = 3; + //------------------------------------------------------------------------- + + // DocMerge from idl: value com::sun::star::sdbc::KeyRule::SET_DEFAULT + /** A possible value for the columns <code>UPDATE_RULE</code> + and <code>DELETE_RULE</code> in the + <code>XResultSet</code> objects returned by the methods + <code>getImportedKeys</code>, <code>getExportedKeys</code>, + and <code>getCrossReference</code>. + <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. + */ + const long SET_DEFAULT = 4; +}; + +//============================================================================= + +}; }; }; }; + +/*=========================================================================== + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:40 hjs + initial import + + Revision 1.3 2000/09/11 11:52:42 mi + documentation merged from XML + + Revision 1.1 1999/11/24 08:41:01 dg + new StarDataBaseConnectivity + +===========================================================================*/ +#endif diff --git a/offapi/com/sun/star/sdbc/PreparedStatement.idl b/offapi/com/sun/star/sdbc/PreparedStatement.idl new file mode 100644 index 000000000000..c9e2ad553eab --- /dev/null +++ b/offapi/com/sun/star/sdbc/PreparedStatement.idl @@ -0,0 +1,290 @@ +/************************************************************************* + * + * $RCSfile: PreparedStatement.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:57 $ + * + * 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_sdbc_PreparedStatement_idl__ +#define __com_sun_star_sdbc_PreparedStatement_idl__ + +#ifndef __com_sun_star_lang_XComponent_idl__ +#include <com/sun/star/lang/XComponent.idl> +#endif + +#ifndef __com_sun_star_beans_XPropertySet_idl__ +#include <com/sun/star/beans/XPropertySet.idl> +#endif + +#ifndef __com_sun_star_util_XCancellable_idl__ +#include <com/sun/star/util/XCancellable.idl> +#endif + + module com { module sun { module star { module sdbc { + +interface XPreparedStatement; +interface XPreparedBatchExecution; +interface XParameters; +interface XClearParameters; +interface XWarningsSupplier; +interface XMultipleResults; +interface XResultSetMetaDataSupplier; +interface XCloseable; + + +// DocMerge from idl: service com::sun::star::sdbc::PreparedStatement +/** represents a precompiled SQL statement. + <P>A SQL statement is pre-compiled and stored in a PreparedStatement object. + This object can then be used to efficiently execute this statement multiple + times. + <P><B>Note:</B> The setXXX methods for setting IN parameter values + must specify types that are compatible with the defined SQL type of + the input parameter. For instance, if the IN parameter has SQL type + Integer, then the method <code>setLong</code> should be used. + + <p>If arbitrary parameter type conversions are required, the method + <code>setObject</code> should be used with a target SQL type. + <br> + Example of setting a parameter; <code>con</code> is an active connection. + @example:StarBASIC + <listing> + pstmt = con.prepareStatement("UPDATE EMPLOYEES SET SALARY = ? WHERE ID = ?") + pstmt.setDouble(1, 153833.00) + pstmt.setLong(2, 110592) + </listing> + <P>Only one ResultSet per Statement can be open at any point in + time. Therefore, if the reading of one ResultSet is interleaved + with the reading of another, each must have been generated by + different Statements. All statement <code>execute</code> methods implicitly + close a statement's current ResultSet if an open one exists. + */ +service PreparedStatement +{ + + // DocMerge from xml: service com::sun::star::sdbc::PreparedStatement: interface com::sun::star::lang::XComponent + /** optional for implementation, controls the releasing of resources + and the notification of registered listeners. + */ + interface com::sun::star::lang::XComponent; + + + // DocMerge from xml: service com::sun::star::sdbc::PreparedStatement: interface com::sun::star::sdbc::XCloseable + /** freeing all resources of a statement. A related resultset will be + freed as well. + */ + interface XCloseable; + + // DocMerge: empty anyway + interface com::sun::star::beans::XPropertySet; + + // DocMerge from xml: service com::sun::star::sdbc::PreparedStatement: interface com::sun::star::util::XCancellable + /** could be used for cancelling the execution of SQL statements if both + if both the DBMS and the driver support aborting an SQL statement. + The implementation is optional. + */ + interface com::sun::star::util::XCancellable; + + + // DocMerge from xml: service com::sun::star::sdbc::PreparedStatement: interface com::sun::star::sdbc::XPreparedStatement + /** is the interface for executing sql prepared commands. + */ + interface XPreparedStatement; + + + // DocMerge from xml: service com::sun::star::sdbc::PreparedStatement: interface com::sun::star::sdbc::XResultSetMetaDataSupplier + /** provides the access to the result set description. + */ + interface XResultSetMetaDataSupplier; + + + // DocMerge from xml: service com::sun::star::sdbc::PreparedStatement: interface com::sun::star::sdbc::XParameters + /** is used for setting parameters before execution of the precompiled + statement. + */ + interface XParameters; + + + // DocMerge from xml: service com::sun::star::sdbc::PreparedStatement: interface com::sun::star::sdbc::XClearParameters + /** clearing of previously defined parameter values. + */ + interface XClearParameters; + + + // DocMerge from xml: service com::sun::star::sdbc::PreparedStatement: interface com::sun::star::sdbc::XPreparedBatchExecution + /** provides the ability of batch execution. This interface is optional + for execution. + <p>A driver implementing batch execution must return <TRUE/> for + <method scope= "com::sun::star::sdbc"> + XDatabaseMetaData::supportsBatchUpdates()</method> + */ + interface XPreparedBatchExecution; + + + // DocMerge from xml: service com::sun::star::sdbc::PreparedStatement: interface com::sun::star::sdbc::XWarningsSupplier + /** controls the chaining of warnings, which may occur on every call + to the connected database. Chained warnings from previous calls will be + cleared before processing a new call. + */ + interface XWarningsSupplier; + + + // DocMerge from xml: service com::sun::star::sdbc::PreparedStatement: interface com::sun::star::sdbc::XMultipleResults + /** covers the handling of multiple results after executing an SQL command. + */ + interface XMultipleResults; + + + // DocMerge from idl: property com::sun::star::sdbc::PreparedStatement::QueryTimeOut + /** retrieves the number of seconds the driver will wait for a Statement + to execute. If the limit is exceeded, a SQLException is thrown. + There is no limitation if set to zero. + */ + [property] long QueryTimeOut; + + + // DocMerge from idl: property com::sun::star::sdbc::PreparedStatement::MaxFieldSize + /** returns the maximum number of bytes allowed for any column value. + <p>This limit is the maximum number of bytes that can be returned + for any column value. The limit applies only to BINARY, + VARBINARY, LONGVARBINARY, CHAR, VARCHAR, and LONGVARCHAR columns. + If the limit is exceeded, the excess data is silently discarded. + <br>There is no limitation if set to zero. + */ + [property] long MaxFieldSize; + + + // DocMerge from idl: property com::sun::star::sdbc::PreparedStatement::MaxRows + /** retrieves the maximum number of rows that a ResultSet can contain. + If the limit is exceeded, the excess rows are silently dropped. + <br>There is no limitation if set to zero. + */ + [property] long MaxRows; + + + // DocMerge from idl: property com::sun::star::sdbc::PreparedStatement::CursorName + /** defines the SQL cursor name that will be used by subsequent Statement + <code>execute</code> methods. + <p>This name can then be used in SQL positioned update/delete statements to + identify the current row in the ResultSet generated by this statement. If + the database doesn't support positioned update/delete, this property is + a noop. To insure that a cursor has the proper isolation level to support + updates, the cursor's SELECT statement should be of the form + 'select for update ...'. If the 'for update' phrase is omitted, + positioned updates may fail. + <P><B>Note:</B> By definition, positioned update/delete + execution must be done by a different Statement than the one + which generated the ResultSet being used for positioning. Also, + cursor names must be unique within a connection. + */ + [property] string CursorName; + + + // DocMerge from idl: property com::sun::star::sdbc::PreparedStatement::ResultSetConcurrency + /** retrieves the result set concurrency. + @see com::sun::star::sdbc::ResultSetConcurrency; + */ + [property] long ResultSetConcurrency; + + + // DocMerge from idl: property com::sun::star::sdbc::PreparedStatement::ResultSetType + /** Determine the result set type. + @see com::sun::star::sdbc::ResultSetType; + */ + [property] long ResultSetType; + + + // DocMerge from idl: property com::sun::star::sdbc::PreparedStatement::FetchDirection + /** retrieves the direction for fetching rows from database tables + that is the default for result sets generated from this + <code>Statement</code> object.<br> + If this <code>Statement</code> object has not set a fetch direction, + the return value is implementation-specific. + */ + [property] long FetchDirection; + + + // DocMerge from idl: property com::sun::star::sdbc::PreparedStatement::FetchSize + /** retrieves the number of result set rows that is the default fetch size + for result sets generated from this <code>Statement</code> object.<br> + If this <code>Statement</code> object has not set a fetch size, + the return value is implementation-specific. + */ + [property] long FetchSize; +}; + +//============================================================================= + +}; }; }; }; + +/*=========================================================================== + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:40 hjs + initial import + + Revision 1.5 2000/09/11 11:52:42 mi + documentation merged from XML + + Revision 1.3 1999/12/20 16:11:34 dg + #70278# changes in API + + Revision 1.2 1999/12/14 12:05:45 dg + #70278# CompareBookmark removed + + Revision 1.1 1999/11/24 08:41:01 dg + new StarDataBaseConnectivity + +===========================================================================*/ +#endif diff --git a/offapi/com/sun/star/sdbc/ProcedureColumn.idl b/offapi/com/sun/star/sdbc/ProcedureColumn.idl new file mode 100644 index 000000000000..4d771b4d6bfb --- /dev/null +++ b/offapi/com/sun/star/sdbc/ProcedureColumn.idl @@ -0,0 +1,147 @@ +/************************************************************************* + * + * $RCSfile: ProcedureColumn.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:57 $ + * + * 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_sdbc_ProcedureColumn_idl__ +#define __com_sun_star_sdbc_ProcedureColumn_idl__ + + module com { module sun { module star { module sdbc { + + +// DocMerge from idl: constants com::sun::star::sdbc::ProcedureColumn +/** indicates the type of a procedure column. + */ +constants ProcedureColumn +{ + + // DocMerge from idl: value com::sun::star::sdbc::ProcedureColumn::UNKNOWN + /** indicates that type of the column is unknown. A possible value for + the column <code>COLUMN_TYPE</code> in the <code>XResultSet</code> + returned by the method <code>getProcedureColumns</code>. + */ + const long UNKNOWN = 0; + //------------------------------------------------------------------------- + + // DocMerge from idl: value com::sun::star::sdbc::ProcedureColumn::IN + /** indicates that the column stores IN parameters. + A possible value for the column + <code>COLUMN_TYPE</code> + in the <code>XResultSet</code> + returned by the method <code>getProcedureColumns</code>. + */ + const long IN = 1; + //------------------------------------------------------------------------- + + // DocMerge from idl: value com::sun::star::sdbc::ProcedureColumn::INOUT + /** indicates that the column stores INOUT parameters. + A possible value for the column + <code>COLUMN_TYPE</code> + in the <code>XResultSet</code> + returned by the method <code>getProcedureColumns</code>. + */ + const long INOUT = 2; + //------------------------------------------------------------------------- + + // DocMerge from idl: value com::sun::star::sdbc::ProcedureColumn::RESULT + /** indicates that the column stores results. + A possible value for the column + <code>COLUMN_TYPE</code> + in the <code>XResultSet</code> + returned by the method <code>getProcedureColumns</code>. + */ + const long RESULT = 3; + //------------------------------------------------------------------------- + + // DocMerge from idl: value com::sun::star::sdbc::ProcedureColumn::OUT + /** indicates that the column stores OUT parameters. + A possible value for the column + <code>COLUMN_TYPE</code> + in the <code>XResultSet</code> + returned by the method <code>getProcedureColumns</code>. + */ + const long OUT = 4; + //------------------------------------------------------------------------- + + // DocMerge from idl: value com::sun::star::sdbc::ProcedureColumn::RETURN + /** Indicates that the column stores return values. + A possible value for the column + <code>COLUMN_TYPE</code> + in the <code>XResultSet</code> + returned by the method <code>getProcedureColumns</code>. + */ + const long RETURN = 5; +}; + +//============================================================================= + +}; }; }; }; + +/*=========================================================================== + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:40 hjs + initial import + + Revision 1.3 2000/09/11 11:52:42 mi + documentation merged from XML + + Revision 1.1 1999/11/24 08:41:01 dg + new StarDataBaseConnectivity + +===========================================================================*/ +#endif diff --git a/offapi/com/sun/star/sdbc/ProcedureResult.idl b/offapi/com/sun/star/sdbc/ProcedureResult.idl new file mode 100644 index 000000000000..38a3206389b2 --- /dev/null +++ b/offapi/com/sun/star/sdbc/ProcedureResult.idl @@ -0,0 +1,119 @@ +/************************************************************************* + * + * $RCSfile: ProcedureResult.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:57 $ + * + * 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_sdbc_ProcedureResult_idl__ +#define __com_sun_star_sdbc_ProcedureResult_idl__ + + module com { module sun { module star { module sdbc { + + +// DocMerge from idl: constants com::sun::star::sdbc::ProcedureResult +/** determines whether a procedure returns a result or not. + */ +constants ProcedureResult +{ + + // DocMerge from idl: value com::sun::star::sdbc::ProcedureResult::UNKNOWN + /** A possible value for column <code>PROCEDURE_TYPE</code> in the + <code>XResultSet</code> object returned by the method + <code>getProcedures</code>. + <p> Indicates that it is not known whether the procedure returns + a result. + */ + const long UNKNOWN = 0; + //------------------------------------------------------------------------- + + // DocMerge from idl: value com::sun::star::sdbc::ProcedureResult::NONE + /** A possible value for column <code>PROCEDURE_TYPE</code> in the + <code>XResultSet</code> object returned by the method + <code>getProcedures</code>. + <p> Indicates that the procedure does not return + a result. + */ + const long NONE = 1; + //------------------------------------------------------------------------- + + // DocMerge from idl: value com::sun::star::sdbc::ProcedureResult::RETURN + /** A possible value for column <code>PROCEDURE_TYPE</code> in the + <code>XResultSet</code> object returned by the method + <code>getProcedures</code>. + <p> Indicates that the procedure returns + a result. + */ + const long RETURN = 2; +}; + +//============================================================================= + +}; }; }; }; + +/*=========================================================================== + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:40 hjs + initial import + + Revision 1.3 2000/09/11 11:52:42 mi + documentation merged from XML + + Revision 1.1 1999/11/24 08:41:01 dg + new StarDataBaseConnectivity + +===========================================================================*/ +#endif diff --git a/offapi/com/sun/star/sdbc/ResultSet.idl b/offapi/com/sun/star/sdbc/ResultSet.idl new file mode 100644 index 000000000000..480cae8a9612 --- /dev/null +++ b/offapi/com/sun/star/sdbc/ResultSet.idl @@ -0,0 +1,293 @@ +/************************************************************************* + * + * $RCSfile: ResultSet.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:57 $ + * + * 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_sdbc_ResultSet_idl__ +#define __com_sun_star_sdbc_ResultSet_idl__ + +#ifndef __com_sun_star_lang_XComponent_idl__ +#include <com/sun/star/lang/XComponent.idl> +#endif + +#ifndef __com_sun_star_beans_XPropertySet_idl__ +#include <com/sun/star/beans/XPropertySet.idl> +#endif + +#ifndef __com_sun_star_util_XCancellable_idl__ +#include <com/sun/star/util/XCancellable.idl> +#endif + + module com { module sun { module star { module sdbc { + +interface XStatement; +interface XRow; +interface XRowUpdate; +interface XResultSet; +interface XResultSetUpdate; +interface XResultSetMetaDataSupplier; +interface XWarningsSupplier; +interface XColumnLocate; +interface XCloseable; + + +// DocMerge from xml: service com::sun::star::sdbc::ResultSet +/** provides access to a table of data. A ResultSet + object is usually generated by executing a Statement. + + + + <p>A ResultSet maintains a cursor pointing to its current row of + data. Initially the cursor is positioned before the first row. + The 'next' method moves the cursor to the next row. + </p> + <p>The getXXX methods retrieve column values for the current + row. You can retrieve values using either the index number of the + column of the column. Columns are numbered from 1. + </p> + <p>For maximum portability, ResultSet columns within each row should be + read in left-to-right order and each column should be read only once. + </p> + <p>For the getXXX methods, the SDBC driver attempts to convert the + underlying data to the specified type and returns a suitable + value. + </p> + <p>Column names used as input to the findColumn method are case + insensitive. When several columns have the same name, then the value + of the first matching column will be returned. The column name option is + designed to be used when column names are used in the SQL + query. For columns that are NOT explicitly named in the query, it + is best to use column numbers. If column names are used, there is + no way for the programmer to guarantee that they actually refer to + the intended columns. + </p> + <p>A ResultSet is automatically closed (disposed) by the Statement that + generated it when that Statement is closed, re-executed, or used + to retrieve the next result from a sequence of multiple results. + </p> + <p>The number, types and properties of a ResultSet's columns are + provided by the ResultSetMetaData object returned by the getMetaData + method.</p> + */ +service ResultSet +{ + + // DocMerge from xml: service com::sun::star::sdbc::ResultSet: interface com::sun::star::lang::XComponent + /** optional for implementation, controls the releasing of resources + and the notification of registered listeners. + */ + interface com::sun::star::lang::XComponent; + + + // DocMerge from xml: service com::sun::star::sdbc::ResultSet: interface com::sun::star::sdbc::XCloseable + /** freeing all resources of a result set. + + <p>The creating statement will still be open after disposing. + + <p>This interface is mandatory only for JDBC conformance, + otherwise it is optional. + */ + interface XCloseable; + + // DocMerge: empty anyway + interface com::sun::star::beans::XPropertySet; + + + // DocMerge from xml: service com::sun::star::sdbc::ResultSet: interface com::sun::star::sdbc::XWarningsSupplier + /** controls the chaining of warnings, which may occur on every call + to the connected database. + + <p>Chained warnings from previous calls will be + cleared before processing a new call. + + <p>This interface is mandatory only for JDBC conformance, + otherwise it is optional. + */ + interface XWarningsSupplier; + + + // DocMerge from xml: service com::sun::star::sdbc::ResultSet: interface com::sun::star::sdbc::XResultSetMetaDataSupplier + /** provides the access to the result set description. + */ + interface XResultSetMetaDataSupplier; + + + // DocMerge from xml: service com::sun::star::sdbc::ResultSet: interface com::sun::star::sdbc::XResultSet + /** is the interface for navigating on the rows on a result set. + */ + interface XResultSet; + + + // DocMerge from xml: service com::sun::star::sdbc::ResultSet: interface com::sun::star::sdbc::XResultSetUpdate + /** is the interface for updating row data to the database. + + <p>The implementation is optional. + */ + interface XResultSetUpdate; + + + // DocMerge from xml: service com::sun::star::sdbc::ResultSet: interface com::sun::star::sdbc::XRow + /** is the interface for accessing the data of the current row. + */ + interface XRow; + + + // DocMerge from xml: service com::sun::star::sdbc::ResultSet: interface com::sun::star::sdbc::XColumnLocate + /** is used for locating a column by it's name. + */ + interface XColumnLocate; + + + // DocMerge from xml: service com::sun::star::sdbc::ResultSet: interface com::sun::star::sdbc::XRowUpdate + /** is the interface for updating the data of the current row. + + <p>The implementation is optional. + */ + interface XRowUpdate; + + + // DocMerge from xml: property com::sun::star::sdbc::ResultSet::CursorName + /** defines the SQL cursor name that will be used by subsequent Statement + <code>execute</code> methods. + + + <p>This name can then be used in SQL positioned update/delete statements to + identify the current row in the ResultSet generated by this statement. If + the database doesn't support positioned update/delete, this property is + a noop. To insure that a cursor has the proper isolation level to support + updates, the cursor's SELECT statement should be of the form + 'select for update ...'. If the 'for update' phrase is omitted, + positioned updates may fail. + </p> + <p> + <b>Note:</b> By definition, positioned update/delete + execution must be done by a different Statement than the one + which generated the ResultSet being used for positioning. Also, + cursor names must be unique within a connection.</p> + + + + + + + + @optional + */ + [optional, readonly, property] string CursorName; + + + // DocMerge from xml: property com::sun::star::sdbc::ResultSet::ResultSetConcurrency + /** retrieves the result set concurrency.@see com::sun::star::sdbc::ResultSetConcurrency; + */ + [readonly, property] long ResultSetConcurrency; + + + // DocMerge from xml: property com::sun::star::sdbc::ResultSet::ResultSetType + /** determines the result set type.@see com::sun::star::sdbc::ResultSetType; + */ + [readonly, property] long ResultSetType; + + + // DocMerge from xml: property com::sun::star::sdbc::ResultSet::FetchDirection + /** retrieves the direction for fetching rows from database tables + that is the default for result sets generated from this + <code>Statement</code> object.<br> + If this <code>Statement</code> object has not set a fetch direction, + the return value is implementation-specific. + */ + [property] long FetchDirection; + + + // DocMerge from xml: property com::sun::star::sdbc::ResultSet::FetchSize + /** retrieves the number of result set rows that is the default fetch size + for result sets generated from this <code>Statement</code> object.<br> + If this <code>Statement</code> object has not set a fetch size, + the return value is implementation-specific. + */ + [property] long FetchSize; +}; + +//============================================================================= + +}; }; }; }; + +/*=========================================================================== + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:40 hjs + initial import + + Revision 1.7 2000/09/11 11:52:42 mi + documentation merged from XML + + Revision 1.5 2000/03/16 11:29:22 mi + UCB complient documentation (optional) + + Revision 1.4 1999/12/20 16:11:34 dg + #70278# changes in API + + Revision 1.3 1999/12/14 12:05:45 dg + #70278# CompareBookmark removed + + Revision 1.2 1999/12/01 18:28:40 dg + #70248# documentation + + Revision 1.1 1999/11/24 08:41:01 dg + new StarDataBaseConnectivity + +===========================================================================*/ +#endif diff --git a/offapi/com/sun/star/sdbc/ResultSetConcurrency.idl b/offapi/com/sun/star/sdbc/ResultSetConcurrency.idl new file mode 100644 index 000000000000..5f2536e00e43 --- /dev/null +++ b/offapi/com/sun/star/sdbc/ResultSetConcurrency.idl @@ -0,0 +1,102 @@ +/************************************************************************* + * + * $RCSfile: ResultSetConcurrency.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:57 $ + * + * 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_sdbc_ResultSetConcurrency_idl__ +#define __com_sun_star_sdbc_ResultSetConcurrency_idl__ + + module com { module sun { module star { module sdbc { + + +// DocMerge from idl: constants com::sun::star::sdbc::ResultSetConcurrency +/** describes the different scroll capabilities of a result set. + */ +constants ResultSetConcurrency +{ + + // DocMerge from idl: value com::sun::star::sdbc::ResultSetConcurrency::READ_ONLY + /** is the concurrency mode for a <code>ResultSet</code> object that may NOT be updated. + */ + const long READ_ONLY = 1007; + + + // DocMerge from idl: value com::sun::star::sdbc::ResultSetConcurrency::UPDATABLE + /** is the concurrency mode for a <code>ResultSet</code> object + that may be updated. + */ + const long UPDATABLE = 1008; +}; + +//============================================================================= + +}; }; }; }; + +/*=========================================================================== + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:40 hjs + initial import + + Revision 1.3 2000/09/11 11:52:42 mi + documentation merged from XML + + Revision 1.1 1999/11/24 08:41:01 dg + new StarDataBaseConnectivity + +===========================================================================*/ +#endif diff --git a/offapi/com/sun/star/sdbc/ResultSetType.idl b/offapi/com/sun/star/sdbc/ResultSetType.idl new file mode 100644 index 000000000000..f28013cfae7d --- /dev/null +++ b/offapi/com/sun/star/sdbc/ResultSetType.idl @@ -0,0 +1,110 @@ +/************************************************************************* + * + * $RCSfile: ResultSetType.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:57 $ + * + * 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_sdbc_ResultSetType_idl__ +#define __com_sun_star_sdbc_ResultSetType_idl__ + + module com { module sun { module star { module sdbc { + + +// DocMerge from idl: constants com::sun::star::sdbc::ResultSetType +/** describes the different scroll capabilities of a result set. + */ +constants ResultSetType +{ + + // DocMerge from idl: value com::sun::star::sdbc::ResultSetType::FORWARD_ONLY + /** is the type for a <code>ResultSet</code> object whose cursor may + move only forward. + */ + const long FORWARD_ONLY = 1003; + + + // DocMerge from idl: value com::sun::star::sdbc::ResultSetType::SCROLL_INSENSITIVE + /** is the type for a <code>ResultSet</code> object that is scrollable + but generally not sensitive to changes made by others. + */ + const long SCROLL_INSENSITIVE = 1004; + + + // DocMerge from idl: value com::sun::star::sdbc::ResultSetType::SCROLL_SENSITIVE + /** is the type for a <code>ResultSet</code> object that is scrollable + and generally sensitive to changes made by others. + */ + const long SCROLL_SENSITIVE = 1005; +}; + +//============================================================================= + +}; }; }; }; + +/*=========================================================================== + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:40 hjs + initial import + + Revision 1.3 2000/09/11 11:52:42 mi + documentation merged from XML + + Revision 1.1 1999/11/24 08:41:02 dg + new StarDataBaseConnectivity + +===========================================================================*/ +#endif diff --git a/offapi/com/sun/star/sdbc/RowSet.idl b/offapi/com/sun/star/sdbc/RowSet.idl new file mode 100644 index 000000000000..3804dc804495 --- /dev/null +++ b/offapi/com/sun/star/sdbc/RowSet.idl @@ -0,0 +1,228 @@ +/************************************************************************* + * + * $RCSfile: RowSet.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:57 $ + * + * 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_sdbc_RowSet_idl__ +#define __com_sun_star_sdbc_RowSet_idl__ + +#ifndef __com_sun_star_sdbc_ResultSet_idl__ +#include <com/sun/star/sdbc/ResultSet.idl> +#endif + + module com { module sun { module star { module container { +interface XNameAccess; +};};};}; + + module com { module sun { module star { module sdbc { + +interface XRowSet; +interface XParameters; +interface XClearParameters; + + +// DocMerge from xml: service com::sun::star::container::com::sun::star::sdbc::RowSet +/** is a client side ResultSet, which combines the characteristics of a Statement + and a ResultSet. + + + <p> It acts like a typical bean. Before you use the RowSet, you have to specify a + set of properties like a DataSource and a Command and other properties known of + Statement.<br> + Afterwards you can populate the RowSet by its execute method to fill the set + with data. + </p> + <p>On the one hand a RowSet can be used as a short cut to retrieve the data of a DataSource. + You don't have to establish a connection, create a Statement and then create + a ResultSet. On the other hand, a rowset can be used to implement capabilties for + a result set, which are not supported by a driver result set, like caching + strategies or update capabilities.</p> + */ +service RowSet +{ + // DocMerge: empty anyway + service com::sun::star::sdbc::ResultSet; + + // DocMerge: empty anyway + interface XRowSet; + + // DocMerge: empty anyway + interface XParameters; + + // DocMerge: empty anyway + interface XClearParameters; + + + // DocMerge from xml: property com::sun::star::container::com::sun::star::sdbc::RowSet::DataSourceName + /** is the name of a named datasource to use.@see com::sun::star::sdbc:XDataSource + */ + [property] string DataSourceName; + + + // DocMerge from xml: property com::sun::star::container::com::sun::star::sdbc::RowSet::URL + /** is the connection URL. Could be used instead of the DataSourceName. + */ + [property] string URL; + + + // DocMerge from xml: property com::sun::star::container::com::sun::star::sdbc::RowSet::Command + /** is the command which should be executed. + */ + [property] string Command; + + + // DocMerge from xml: property com::sun::star::container::com::sun::star::sdbc::RowSet::TransactionIsolation + /** indicates the transaction isolation level, which should be used for the + connection.@see com::sun::star::sdbc::TransactionIsolation + */ + [property] long TransactionIsolation; + + + // DocMerge from xml: property com::sun::star::container::com::sun::star::sdbc::RowSet::TypeMap + /** is the type map that will be used for the custom mapping of SQL structured types + and distinct types. + */ + [property] com::sun::star::container::XNameAccess TypeMap; + + + // DocMerge from xml: property com::sun::star::container::com::sun::star::sdbc::RowSet::EscapeProcessing + /** returns if escape processing is on or off. + If escape scanning is on (the default), the driver will do + escape substitution before sending the SQL to the database. + This is only evaluated, if the CommandType is COMMAND. + */ + [property] boolean EscapeProcessing; + + + // DocMerge from xml: property com::sun::star::container::com::sun::star::sdbc::RowSet::QueryTimeOut + /** retrieves the number of seconds the driver will wait for a Statement + to execute. If the limit is exceeded, a SQLException is thrown. + There is no limitation if set to zero. + */ + [property] long QueryTimeOut; + + + // DocMerge from xml: property com::sun::star::container::com::sun::star::sdbc::RowSet::MaxFieldSize + /** returns the maximum number of bytes allowed for any column value. + + + <p>This limit is the maximum number of bytes that can be returned + for any column value. The limit applies only to BINARY, + VARBINARY, LONGVARBINARY, CHAR, VARCHAR, and LONGVARCHAR columns. + If the limit is exceeded, the excess data is silently discarded. + <br>There is no limitation if set to zero.</p> + */ + [property] long MaxFieldSize; + + + // DocMerge from xml: property com::sun::star::container::com::sun::star::sdbc::RowSet::MaxRows + /** retrieves the maximum number of rows that a ResultSet can contain. + If the limit is exceeded, the excess rows are silently dropped. + <br>There is no limitation if set to zero. + */ + [property] long MaxRows; + + + // DocMerge from xml: property com::sun::star::container::com::sun::star::sdbc::RowSet::User + /** determines the user for whom to open the connection. + */ + [property] string User; + + + // DocMerge from xml: property com::sun::star::container::com::sun::star::sdbc::RowSet::Password + /** determines the user for whom to open the connection. + */ + [property] string Password; + + + // DocMerge from xml: property com::sun::star::container::com::sun::star::sdbc::RowSet::ResultSetType + /** determine the result set type.@see com::sun::star::sdbc::ResultSetType; + */ + [property] long ResultSetType; +}; + +//============================================================================= + +}; }; }; }; + +/*=========================================================================== + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:41 hjs + initial import + + Revision 1.7 2000/09/11 11:52:42 mi + documentation merged from XML + + Revision 1.5 2000/01/27 08:08:01 dg + #72164# EscapeProcessing instead of UseEscapeProcessing + + Revision 1.4 1999/12/20 16:11:34 dg + #70278# changes in API + + Revision 1.3 1999/12/14 12:05:45 dg + #70278# CompareBookmark removed + + Revision 1.2 1999/12/10 12:37:30 dg + #70278# documentation + + Revision 1.1 1999/12/09 12:41:20 dg + #70278# new service + + +===========================================================================*/ +#endif diff --git a/offapi/com/sun/star/sdbc/SQLException.idl b/offapi/com/sun/star/sdbc/SQLException.idl new file mode 100644 index 000000000000..aa0e871957ea --- /dev/null +++ b/offapi/com/sun/star/sdbc/SQLException.idl @@ -0,0 +1,124 @@ +/************************************************************************* + * + * $RCSfile: SQLException.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:57 $ + * + * 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_sdbc_SQLException_idl__ +#define __com_sun_star_sdbc_SQLException_idl__ + +#ifndef __com_sun_star_uno_Exception_idl__ +#include <com/sun/star/uno/Exception.idl> +#endif + + module com { module sun { module star { module sdbc { + + +// DocMerge from xml: exception com::sun::star::sdbc::SQLException +/** is an exception that provides information on a database access error. + + + + <p>Each <type scope="com::sun::star::sdbc">SQLException</type> provides several kinds of information: + </p> + <ul> + <li> a string describing the error. This is used as the <type scope="com::sun::star::uno">Exception</type> + message. + </li> + </ul> + */ +exception SQLException: com::sun::star::uno::Exception +{ + // DocMerge from xml: field com::sun::star::sdbc::SQLException::SQLState + /** returns a string, which use the XOPEN SQLState conventions. + The values of the SQLState string are described in the XOPEN SQL spec. + */ + string SQLState; + + // DocMerge from xml: field com::sun::star::sdbc::SQLException::ErrorCode + /** returns an integer error code that is specific to each vendor. Normally this will + be the actual error code returned by the underlying database. + a chain to a next Exception. This can be used to provide additional + error information. + */ + long ErrorCode; + + // DocMerge from xml: field com::sun::star::sdbc::SQLException::NextException + /** returns a chain to a next Exception. + This can be used to provide additional + error information. + */ + any NextException; +}; + +//============================================================================= + +}; }; }; }; + +/*=========================================================================== + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:41 hjs + initial import + + Revision 1.3 2000/09/11 11:52:42 mi + documentation merged from XML + + Revision 1.1 1999/11/24 08:41:02 dg + new StarDataBaseConnectivity + +===========================================================================*/ +#endif diff --git a/offapi/com/sun/star/sdbc/SQLWarning.idl b/offapi/com/sun/star/sdbc/SQLWarning.idl new file mode 100644 index 000000000000..908fbd802515 --- /dev/null +++ b/offapi/com/sun/star/sdbc/SQLWarning.idl @@ -0,0 +1,98 @@ +/************************************************************************* + * + * $RCSfile: SQLWarning.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:57 $ + * + * 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_sdbc_SQLWarning_idl__ +#define __com_sun_star_sdbc_SQLWarning_idl__ + +#ifndef __com_sun_star_sdbc_SQLException_idl__ +#include <com/sun/star/sdbc/SQLException.idl> +#endif + + module com { module sun { module star { module sdbc { + + +// DocMerge from xml: exception com::sun::star::sdbc::SQLWarning +/** is an exception that provides information on database access + warnings. Warnings are silently chained to the object whose method + caused it to be reported.@see XConnection::getWarnings() + @see XResultSet::getWarnings() + @see XStatement::getWarnings() + */ +exception SQLWarning: SQLException +{ +}; + +//============================================================================= + +}; }; }; }; + +/*=========================================================================== + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:41 hjs + initial import + + Revision 1.3 2000/09/11 11:52:42 mi + documentation merged from XML + + Revision 1.1 1999/11/24 08:41:02 dg + new StarDataBaseConnectivity + +===========================================================================*/ +#endif diff --git a/offapi/com/sun/star/sdbc/Statement.idl b/offapi/com/sun/star/sdbc/Statement.idl new file mode 100644 index 000000000000..a92cf0d51fcc --- /dev/null +++ b/offapi/com/sun/star/sdbc/Statement.idl @@ -0,0 +1,273 @@ +/************************************************************************* + * + * $RCSfile: Statement.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:57 $ + * + * 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_sdbc_Statement_idl__ +#define __com_sun_star_sdbc_Statement_idl__ + +#ifndef __com_sun_star_lang_XComponent_idl__ +#include <com/sun/star/lang/XComponent.idl> +#endif + +#ifndef __com_sun_star_beans_XPropertySet_idl__ +#include <com/sun/star/beans/XPropertySet.idl> +#endif + +#ifndef __com_sun_star_util_XCancellable_idl__ +#include <com/sun/star/util/XCancellable.idl> +#endif + + module com { module sun { module star { module sdbc { + +interface XWarningsSupplier; +interface XStatement; +interface XBatchExecution; +interface XMultipleResults; +interface XCloseable; + + +// DocMerge from xml: service com::sun::star::sdbc::Statement +/** is used for executing a static SQL statement and obtaining the results + produced by it. + + + + <p>Only one ResultSet per Statement can be open at any point in + time. Therefore, if the reading of one ResultSet is interleaved + with the reading of another, each must have been generated by + different Statements. All statement <code>execute</code> methods implicitly + close a statement's current ResultSet if an open one exists.</p> + */ +service Statement +{ + + // DocMerge from xml: service com::sun::star::sdbc::Statement: interface com::sun::star::lang::XComponent + /** optional for implementation, controls the releasing of resources + and the notification of registered listeners. + */ + interface com::sun::star::lang::XComponent; + + + // DocMerge from xml: service com::sun::star::sdbc::Statement: interface com::sun::star::sdbc::XCloseable + /** freeing all resources of a statement. A related resultset will be + freed as well. + */ + interface XCloseable; + + // DocMerge: empty anyway + interface com::sun::star::beans::XPropertySet; + + // DocMerge from xml: service com::sun::star::sdbc::Statement: interface com::sun::star::util::XCancellable + /** could be used for cancelling the execution of SQL statements if both + if both the DBMS and the driver support aborting an SQL statement. + The implementation is optional. + */ + interface com::sun::star::util::XCancellable; + + + // DocMerge from xml: service com::sun::star::sdbc::Statement: interface com::sun::star::sdbc::XStatement + /** is the interface for executing sql commands. + */ + interface XStatement; + + + // DocMerge from xml: service com::sun::star::sdbc::Statement: interface com::sun::star::sdbc::XBatchExecution + /** provides the ability of batch execution. This interface is optional + for execution. + <p>A driver implementing batch execution must return <TRUE/> for + <method scope= "com::sun::star::sdbc"> + XDatabaseMetaData::supportsBatchUpdates()</method> + */ + interface XBatchExecution; + + + // DocMerge from xml: service com::sun::star::sdbc::Statement: interface com::sun::star::sdbc::XWarningsSupplier + /** controls the chaining of warnings, which may occur on every call + to the connected database. Chained warnings from previous calls will be + cleared before processing a new call. + */ + interface XWarningsSupplier; + + + // DocMerge from xml: service com::sun::star::sdbc::Statement: interface com::sun::star::sdbc::XMultipleResults + /** covers the handling of multiple results after executing an SQL command. + The implementation is optional. + */ + interface XMultipleResults; + + + // DocMerge from xml: property com::sun::star::sdbc::Statement::QueryTimeOut + /** retrieves the number of seconds the driver will wait for a Statement + to execute. If the limit is exceeded, a SQLException is thrown. + There is no limitation if set to zero. + */ + [property] long QueryTimeOut; + + + // DocMerge from xml: property com::sun::star::sdbc::Statement::MaxFieldSize + /** returns the maximum number of bytes allowed for any column value. + + + <p>This limit is the maximum number of bytes that can be returned + for any column value. The limit applies only to BINARY, + VARBINARY, LONGVARBINARY, CHAR, VARCHAR, and LONGVARCHAR columns. + If the limit is exceeded, the excess data is silently discarded. + <br>There is no limitation if set to zero.</p> + */ + [property] long MaxFieldSize; + + + // DocMerge from xml: property com::sun::star::sdbc::Statement::MaxRows + /** retrieves the maximum number of rows that a ResultSet can contain. + If the limit is exceeded, the excess rows are silently dropped. + <br>There is no limitation if set to zero. + */ + [property] long MaxRows; + + + // DocMerge from xml: property com::sun::star::sdbc::Statement::CursorName + /** defines the SQL cursor name that will be used by subsequent Statement + <code>execute</code> methods. + + + <p>This name can then be used in SQL positioned update/delete statements to + identify the current row in the ResultSet generated by this statement. If + the database doesn't support positioned update/delete, this property is + a noop. To insure that a cursor has the proper isolation level to support + updates, the cursor's SELECT statement should be of the form + 'select for update ...'. If the 'for update' phrase is omitted, + positioned updates may fail. + </p> + <p> + <b>Note:</b> By definition, positioned update/delete + execution must be done by a different Statement than the one + which generated the ResultSet being used for positioning. Also, + cursor names must be unique within a connection.</p> + */ + [property] string CursorName; + + + // DocMerge from xml: property com::sun::star::sdbc::Statement::ResultSetConcurrency + /** retrieves the result set concurrency.@see com::sun::star::sdbc::ResultSetConcurrency; + */ + [property] long ResultSetConcurrency; + + + // DocMerge from xml: property com::sun::star::sdbc::Statement::ResultSetType + /** determine the result set type.@see com::sun::star::sdbc::ResultSetType; + */ + [property] long ResultSetType; + + + // DocMerge from xml: property com::sun::star::sdbc::Statement::FetchDirection + /** retrieves the direction for fetching rows from database tables + that is the default for result sets generated from this + <code>Statement</code> object.<br> + If this <code>Statement</code> object has not set a fetch direction, + the return value is implementation-specific. + */ + [property] long FetchDirection; + + + // DocMerge from xml: property com::sun::star::sdbc::Statement::FetchSize + /** retrieves the number of result set rows that is the default fetch size + for result sets generated from this <code>Statement</code> object.<br> + If this <code>Statement</code> object has not set a fetch size, + the return value is implementation-specific. + */ + [property] long FetchSize; + + + // DocMerge from xml: property com::sun::star::sdbc::Statement::EscapeProcessing + /** returns if escape processing is on or off. + If escape scanning is on (the default), the driver will do + escape substitution before sending the SQL to the database. + */ + [property] boolean EscapeProcessing; +}; + +//============================================================================= + +}; }; }; }; + +/*=========================================================================== + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:41 hjs + initial import + + Revision 1.7 2000/09/11 11:52:42 mi + documentation merged from XML + + Revision 1.5 2000/01/27 08:08:01 dg + #72164# EscapeProcessing instead of UseEscapeProcessing + + Revision 1.4 1999/12/20 16:11:34 dg + #70278# changes in API + + Revision 1.3 1999/12/14 12:05:45 dg + #70278# CompareBookmark removed + + Revision 1.2 1999/11/30 20:21:19 dg + #70248# XMultipleResultSet optional + + Revision 1.1 1999/11/24 08:41:02 dg + new StarDataBaseConnectivity + +===========================================================================*/ +#endif diff --git a/offapi/com/sun/star/sdbc/TransactionIsolation.idl b/offapi/com/sun/star/sdbc/TransactionIsolation.idl new file mode 100644 index 000000000000..dc1915f6afc8 --- /dev/null +++ b/offapi/com/sun/star/sdbc/TransactionIsolation.idl @@ -0,0 +1,134 @@ +/************************************************************************* + * + * $RCSfile: TransactionIsolation.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:57 $ + * + * 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_sdbc_TransactionIsolation_idl__ +#define __com_sun_star_sdbc_TransactionIsolation_idl__ + + module com { module sun { module star { module sdbc { + + +// DocMerge from idl: constants com::sun::star::sdbc::TransactionIsolation +/** distinguishs different possible transaction isolation levels. + */ +constants TransactionIsolation +{ + + // DocMerge from idl: value com::sun::star::sdbc::TransactionIsolation::NONE + /** indicates that transactions are not supported. + */ + const long NONE = 0; + + // DocMerge from idl: value com::sun::star::sdbc::TransactionIsolation::READ_UNCOMMITTED + /** Dirty reads, non-repeatable reads and phantom reads can occur. + This level allows a row changed by one transaction to be read + by another transaction before any changes in that row have been + committed (a "dirty read"). If any of the changes are rolled back, + the second transaction will have retrieved an invalid row. + */ + const long READ_UNCOMMITTED = 1; + + // DocMerge from idl: value com::sun::star::sdbc::TransactionIsolation::READ_COMMITTED + /** Dirty reads are prevented; non-repeatable reads and phantom + reads can occur. This level only prohibits a transaction + from reading a row with uncommitted changes in it. + */ + const long READ_COMMITTED = 2; + + // DocMerge from idl: value com::sun::star::sdbc::TransactionIsolation::REPEATABLE_READ + /** Dirty reads and non-repeatable reads are prevented; phantom + reads can occur. This level prohibits a transaction from + reading a row with uncommitted changes in it, and it also + prohibits the situation where one transaction reads a row, + a second transaction alters the row, and the first transaction + rereads the row, getting different values the second time + (a "non-repeatable read"). + */ + const long REPEATABLE_READ = 4; + + // DocMerge from idl: value com::sun::star::sdbc::TransactionIsolation::SERIALIZABLE + /** Dirty reads, non-repeatable reads and phantom reads are prevented. + This level includes the prohibitions in + <code>REPEATABLE_READ</code> and further prohibits the + situation where one transaction reads all rows that satisfy + a WHERE condition, a second transaction inserts a row that + satisfies that WHERE condition, and the first transaction + rereads for the same condition, retrieving the additional + "phantom" row in the second read. + */ + const long SERIALIZABLE = 8; +}; + +//============================================================================= + +}; }; }; }; + +/*=========================================================================== + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:41 hjs + initial import + + Revision 1.3 2000/09/11 11:52:42 mi + documentation merged from XML + + Revision 1.1 1999/11/24 08:41:03 dg + new StarDataBaseConnectivity + +===========================================================================*/ +#endif diff --git a/offapi/com/sun/star/sdbc/XArray.idl b/offapi/com/sun/star/sdbc/XArray.idl new file mode 100644 index 000000000000..95eed6e52627 --- /dev/null +++ b/offapi/com/sun/star/sdbc/XArray.idl @@ -0,0 +1,236 @@ +/************************************************************************* + * + * $RCSfile: XArray.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:57 $ + * + * 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_sdbc_XArray_idl__ +#define __com_sun_star_sdbc_XArray_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + + module com { module sun { module star { module container { +interface XNameAccess; +};};};}; + +#ifndef __com_sun_star_sdbc_SQLException_idl__ +#include <com/sun/star/sdbc/SQLException.idl> +#endif + + module com { module sun { module star { module sdbc { + +interface XResultSet; + + +// DocMerge from xml: interface com::sun::star::container::com::sun::star::sdbc::XArray +/** is used for mapping the SQL type <code>ARRAY</code>. + By default, an <code>Array</code> is a transaction duration + reference to an SQL array. By default, an <code>Array</code> + is implemented using a SQL LOCATOR(array) internally. + */ +[ uik(D6B60238-9067-11d3-9EE00010-5AD7A5C4), ident("XArray", 1.0) ] +interface XArray: com::sun::star::uno::XInterface +{ + + // DocMerge from xml: method com::sun::star::container::com::sun::star::sdbc::XArray::getBaseTypeName + /** returns the SQL type name of the elements in + the array designated by this <code>Array</code> object. + + + <p>If the elements are a built-in type, it returns + the database-specific type name of the elements. + If the elements are a user-defined type (UDT), + this method returns the fully-qualified SQL type name. + + </p> + */ + [const] string getBaseTypeName() raises (SQLException); + + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::container::com::sun::star::sdbc::XArray::getBaseType + /** returns the SDBC type of the elements in the array designated + by this <code>Array</code> object. + */ + [const] long getBaseType() raises (SQLException); + + //------------------------------------------------------------------------- + + // DocMerge from idl: method com::sun::star::container::com::sun::star::sdbc::XArray::getArray + /** retrieves the contents of the SQL array designated by this + <code>Array</code> object, using the specified <code>typeMap</code> + for type map customizations. + <p>If the base type of the array does not match a user-defined type + in <code>typeMap</code>, the standard mapping is used instead. + + @param typeMap + is a map object that contains mappings of SQL type names to + services. If the <code>typeMap</code> is <NULL/>, the type-map + associated with the connection for customizations of the type-mappings + is used. + + @returns + an sequence that contains the ordered elements + of the SQL array designated by this object. + + @throws SQLException + if an error occurs while attempting to access the array. + */ + sequence<any> getArray([in]com::sun::star::container::XNameAccess typeMap) + raises (SQLException); + + //------------------------------------------------------------------------- + + // DocMerge from idl: method com::sun::star::container::com::sun::star::sdbc::XArray::getArrayAtIndex + /** returns an array containing a slice of the SQL array, beginning with the + specified <code>index</code> and containing up to <code>count</code> + successive elements of the SQL array. + + @param index + is the array index of the first element to retrieve; + the first element is at index 1. + @param count + is the number of successive SQL array elements to retrieve. + @param typeMap + is a map object that contains mappings of SQL type names to + services. If the <code>typeMap</code> is <NULL/>, the type-map + associated with the connection for customizations of the type-mappings + is used. + @returns + an array containing up to <code>count</code> consecutive elements + of the SQL array, beginning with element <code>index</code>. + @throws SQLException + if an error occurs while attempting to access the array. + */ + sequence<any> getArrayAtIndex([in]long index, + [in]long count, + [in]com::sun::star::container::XNameAccess + typeMap) + raises (SQLException); + + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::container::com::sun::star::sdbc::XArray::getResultSet + /** returns a result set that contains the elements of the array + designated by this <code>Array</code> object and uses the given + <code>typeMap</code> to map the array elements. If the base + type of the array does not match a user-defined type in + <code>typeMap</code> or the <code>typeMap</code> is <null></null>, + the connection type mapping is used instead. + + + <p> + The result set contains one row for each array element, with + two columns in each row. The second column stores the element + value; the first column stores the index into the array for + that element (with the first array element being at index 1). + The rows are in ascending order corresponding to + the order of the indices. + </p> + */ + XResultSet getResultSet([in]com::sun::star::container::XNameAccess typeMap) + raises (SQLException); + + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::container::com::sun::star::sdbc::XArray::getResultSetAtIndex + /** returns a result set holding the elements of the subarray that + starts at index <code>index</code> and contains up to + <code>count</code> successive elements. This method uses the given + <code>typeMap</code> to map the array elements. If the base + type of the array does not match a user-defined type in + <code>typeMap</code> or the <code>typeMap</code> is <null></null>, + the connection type mapping is used instead. + + + <p> + The result set contains one row for each array element, with + two columns in each row. The second column stores the element + value; the first column stores the index into the array for + that element (with the first array element being at index 1). + The rows are in ascending order corresponding to + the order of the indices. + </p> + */ + XResultSet getResultSetAtIndex([in]long index, + [in]long count, + [in]com::sun::star::container::XNameAccess typeMap) + raises (SQLException); +}; + +//============================================================================= + +}; }; }; }; + +/*=========================================================================== + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:41 hjs + initial import + + Revision 1.4 2000/09/11 11:52:42 mi + documentation merged from XML + + Revision 1.2 1999/11/24 11:33:26 dg + chk includes + + Revision 1.1 1999/11/24 08:41:03 dg + new StarDataBaseConnectivity + +===========================================================================*/ +#endif diff --git a/offapi/com/sun/star/sdbc/XBatchExecution.idl b/offapi/com/sun/star/sdbc/XBatchExecution.idl new file mode 100644 index 000000000000..bd49ae7f6dcc --- /dev/null +++ b/offapi/com/sun/star/sdbc/XBatchExecution.idl @@ -0,0 +1,125 @@ +/************************************************************************* + * + * $RCSfile: XBatchExecution.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:57 $ + * + * 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_sdbc_XBatchExecution_idl__ +#define __com_sun_star_sdbc_XBatchExecution_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_sdbc_SQLException_idl__ +#include <com/sun/star/sdbc/SQLException.idl> +#endif + + module com { module sun { module star { module sdbc { + +interface XResultSet; + + +// DocMerge from xml: interface com::sun::star::sdbc::XBatchExecution +/** is used for collecting and executing a set of SQL statements. + */ +[ uik(D6B60244-9067-11d3-9EE00010-5AD7A5C4), ident("XBatchExecution", 1.0) ] +interface XBatchExecution: com::sun::star::uno::XInterface +{ + + // DocMerge from xml: method com::sun::star::sdbc::XBatchExecution::addBatch + /** adds a SQL command to the current batch of commmands for the statement + object. + */ + void addBatch([in]string sql ) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XBatchExecution::clearBatch + /** makes the set of commands in the current batch empty. + */ + void clearBatch() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from idl: method com::sun::star::sdbc::XBatchExecution::executeBatch + /** submits a batch of commands to the database for execution. + @returns + an array of update counts containing one element for each + command in the batch. The array is ordered according to the order in + which commands were inserted into the batch. + @throws SQLException + if a database access error occurs. + */ + sequence<long> executeBatch() raises (SQLException); +}; + +//============================================================================= + +}; }; }; }; + +/*=========================================================================== + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:41 hjs + initial import + + Revision 1.3 2000/09/11 11:52:42 mi + documentation merged from XML + + Revision 1.1 1999/11/24 08:41:03 dg + new StarDataBaseConnectivity + +===========================================================================*/ +#endif diff --git a/offapi/com/sun/star/sdbc/XBlob.idl b/offapi/com/sun/star/sdbc/XBlob.idl new file mode 100644 index 000000000000..aa8d1811805a --- /dev/null +++ b/offapi/com/sun/star/sdbc/XBlob.idl @@ -0,0 +1,203 @@ +/************************************************************************* + * + * $RCSfile: XBlob.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:57 $ + * + * 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_sdbc_XBlob_idl__ +#define __com_sun_star_sdbc_XBlob_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + + module com { module sun { module star { module io { +interface XInputStream; +};};};}; + +#ifndef __com_sun_star_sdbc_SQLException_idl__ +#include <com/sun/star/sdbc/SQLException.idl> +#endif + + module com { module sun { module star { module sdbc { + + +// DocMerge from xml: interface com::sun::star::io::com::sun::star::sdbc::XBlob +/** is the representation (mapping) of an SQL <i>BLOB</i>. + + + <p> + A SQL <i>BLOB</i> is a built-in type that stores a + Binary Large Object as a column value in a row of a database table. + The driver implements <i>BLOB</i> using a + SQL <code>locator(BLOB)</code>, which means that a <code>Blob</code> + object contains a logical pointer to the SQL <i>BLOB</i> data rather + than the data itself. + <br> + A <code>Blob</code> object is valid for the duration of the + transaction in which is was created. + + </p> + <p>Methods in the interfaces <type scope="com::sun::star::sdbc">XResultSet</type>, + and <type scope="com::sun::star::sdbc">XPreparedStatement</type>, such as + <code>getBlob</code> and <code>setBlob</code> allow a programmer to + access the SQL <i>BLOB</i>.<br> + The <code>Blob</code> interface provides methods for getting the + length of a SQL <i>BLOB</i> (Binary Large Object) value, + for materializing a <i>BLOB</i> value on the client and for + determining the position of a pattern of bytes within a + <i>BLOB</i> value.</p> + */ +[ uik(D6B6023A-9067-11d3-9EE00010-5AD7A5C4), ident("XBlob", 1.0) ] +interface XBlob: com::sun::star::uno::XInterface +{ + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XBlob::length + /** returns the number of bytes in the <i>BLOB</i> value + designated by this <code>Blob</code> object. + */ + hyper length() raises (SQLException); + + //------------------------------------------------------------------------- + + // DocMerge from idl: method com::sun::star::io::com::sun::star::sdbc::XBlob::getBytes + /** returns as an array of bytes part or all of the <i>BLOB</i> + value that this <code>Blob</code> object designates. The byte + array contains up to <code>length</code> consecutive bytes + starting at position <code>pos</code>. + @param pos + is the ordinal position of the first byte in the + <i>BLOB</i> value to be extracted; the first byte is at + position 1. + @param length + is the number of consecutive bytes to be copied. + @returns + a byte array containing up to <code>length</code> + consecutive bytes from the <i>BLOB</i> value designated + by this <code>Blob</code> object, starting with the + byte at position <code>pos</code>. + @throws SQLException + if there is an error accessing the <i>BLOB</i>. + */ + sequence<byte> getBytes([in]hyper pos, [in]long length) + raises (SQLException); + + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XBlob::getBinaryStream + /** retrieves the <i>BLOB</i> designated by this + <code>Blob</code> instance as a stream. + */ + com::sun::star::io::XInputStream getBinaryStream() + raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XBlob::position + /** determines the byte position at which the specified byte + <code>pattern</code> begins within the <i>BLOB</i> + value that this <code>Blob</code> object represents. The + search for <code>pattern</code> begins at position + <code>start</code>. + */ + hyper position([in]sequence<byte> pattern, [in]hyper start) + raises (SQLException); + + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XBlob::positionOfBlob + /** determines the byte position in the <i>BLOB</i> value + designated by this <code>Blob</code> object at which + <code>pattern</code> begins. The search begins at position + <code>start</code>. + */ + hyper positionOfBlob([in]XBlob pattern,[in] hyper start) + raises (SQLException); +}; + +//============================================================================= + +}; }; }; }; + +/*=========================================================================== + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:41 hjs + initial import + + Revision 1.8 2000/09/11 11:52:42 mi + documentation merged from XML + + Revision 1.6 2000/02/07 11:24:52 mi + zu #70728# missing documentation marked + + Revision 1.5 2000/01/14 11:09:11 mi + XML syntax error in documentation + + Revision 1.4 1999/12/20 16:11:35 dg + #70278# changes in API + + Revision 1.3 1999/12/13 13:47:54 dg + #70278# XSQLErrorBroadcaster removed + + Revision 1.2 1999/11/24 11:33:26 dg + chk includes + + Revision 1.1 1999/11/24 08:41:04 dg + new StarDataBaseConnectivity + +===========================================================================*/ +#endif diff --git a/offapi/com/sun/star/sdbc/XClob.idl b/offapi/com/sun/star/sdbc/XClob.idl new file mode 100644 index 000000000000..56138b58706b --- /dev/null +++ b/offapi/com/sun/star/sdbc/XClob.idl @@ -0,0 +1,182 @@ +/************************************************************************* + * + * $RCSfile: XClob.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:57 $ + * + * 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_sdbc_XClob_idl__ +#define __com_sun_star_sdbc_XClob_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + + module com { module sun { module star { module io { +interface XInputStream; +};};};}; + +#ifndef __com_sun_star_sdbc_SQLException_idl__ +#include <com/sun/star/sdbc/SQLException.idl> +#endif + + module com { module sun { module star { module sdbc { + + +// DocMerge from xml: interface com::sun::star::io::com::sun::star::sdbc::XClob +/** is the mapping for the SQL <code>CLOB</code> type. + + + <p>A SQL <code>CLOB</code> is a built-in type + that stores a Character Large Object as a column value in a row of + a database table. + The driver implements a <code>Clob</code> object using a SQL + <code>locator(CLOB)</code>, which means that a <code>Clob</code> object + contains a logical pointer to the SQL <code>CLOB</code> data rather than + the data itself. A <code>Clob</code> object is valid for the duration + of the transaction in which it was created. + </p> + <p>The <code>Clob</code> interface provides methods for getting the + length of a SQL <code>CLOB</code> (Character Large Object) value, + for materializing a <code>CLOB</code> value on the client, and for + searching for a substring or <code>CLOB</code> object within a + <code>CLOB</code> value. + </p> + <p>Methods in the interfaces <type scope="com::sun::star::sdbc">XResultSet</type>, + and <type scope="com::sun::star::sdbc">XPreparedStatement</type>, such as + <code>getClob</code> and <code>setClob</code> allow a programmer to + access the SQL <code>CLOB</code>.<br> + </p> + */ +[ uik(D6B6023B-9067-11d3-9EE00010-5AD7A5C4), ident("XClob", 1.0) ] +interface XClob: com::sun::star::uno::XInterface +{ + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XClob::length + /** returns the number of characters in the <code>CLOB</code> value + designated by this <code>Clob</code> object. + */ + hyper length() raises (SQLException); + + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XClob::getSubString + /** returns a copy of the specified substring in the <code>CLOB</code> value + designated by this <code>Clob</code> object. + + + <p>The substring begins at position <code>pos</code> and has up + to <code>length</code> consecutive characters. + </p> + */ + string getSubString([in]hyper pos, [in]long length) raises (SQLException); + + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XClob::getCharacterStream + /** gets the <code>Clob</code> contents as a stream. + */ + com::sun::star::io::XInputStream getCharacterStream() raises (SQLException); + + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XClob::position + /** determines the character position at which the specified substring + <code>searchstr</code> appears in the <code>CLOB</code>. The search + begins at position <code>start</code>. + */ + hyper position([in]string searchstr, [in]long start) + raises (SQLException); + + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XClob::positionOfClob + /** determines the character position at which the specified + <code>Clob</code> object <code>searchstr</code> appears in this + <code>Clob</code> object. The search begins at position + <code>start</code>. + */ + hyper positionOfClob([in]XClob pattern, [in]hyper start) + raises (SQLException); +}; + +//============================================================================= + +}; }; }; }; + +/*=========================================================================== + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:41 hjs + initial import + + Revision 1.6 2000/09/11 11:52:42 mi + documentation merged from XML + + Revision 1.4 1999/12/20 16:11:35 dg + #70278# changes in API + + Revision 1.3 1999/12/13 13:47:54 dg + #70278# XSQLErrorBroadcaster removed + + Revision 1.2 1999/11/24 11:33:26 dg + chk includes + + Revision 1.1 1999/11/24 08:41:04 dg + new StarDataBaseConnectivity + +===========================================================================*/ +#endif diff --git a/offapi/com/sun/star/sdbc/XCloseable.idl b/offapi/com/sun/star/sdbc/XCloseable.idl new file mode 100644 index 000000000000..13a33db3737f --- /dev/null +++ b/offapi/com/sun/star/sdbc/XCloseable.idl @@ -0,0 +1,107 @@ +/************************************************************************* + * + * $RCSfile: XCloseable.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:57 $ + * + * 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_sdbc_XCloseable_idl__ +#define __com_sun_star_sdbc_XCloseable_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_sdbc_SQLException_idl__ +#include <com/sun/star/sdbc/SQLException.idl> +#endif + + module com { module sun { module star { module sdbc { + + +// DocMerge from xml: interface com::sun::star::sdbc::XCloseable +/** provides the releasing of resources acquired by the implementing object. + */ +[ uik(4544AE31-AE24-11d3-9ED80050-04D8BBD0), ident("XCloseable", 1.0) ] +interface XCloseable: com::sun::star::uno::XInterface +{ + + // DocMerge from xml: method com::sun::star::sdbc::XCloseable::close + /** releases all resources connected to an object. + */ + void close() raises (SQLException); +}; + +//============================================================================= + +}; }; }; }; + +/*=========================================================================== + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:41 hjs + initial import + + Revision 1.3 2000/09/11 11:52:43 mi + documentation merged from XML + + Revision 1.1 1999/12/20 16:15:54 dg + #70278# XClosable new + + Revision 1.1 1999/11/24 08:41:04 dg + new StarDataBaseConnectivity + +===========================================================================*/ +#endif diff --git a/offapi/com/sun/star/sdbc/XColumnLocate.idl b/offapi/com/sun/star/sdbc/XColumnLocate.idl new file mode 100644 index 000000000000..c5af087ef5aa --- /dev/null +++ b/offapi/com/sun/star/sdbc/XColumnLocate.idl @@ -0,0 +1,119 @@ +/************************************************************************* + * + * $RCSfile: XColumnLocate.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:57 $ + * + * 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_sdbc_XColumnLocate_idl__ +#define __com_sun_star_sdbc_XColumnLocate_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_sdbc_SQLException_idl__ +#include <com/sun/star/sdbc/SQLException.idl> +#endif + + module com { module sun { module star { module sdbc { + +interface XResultSetMetaData; + + +// DocMerge from xml: interface com::sun::star::sdbc::XColumnLocate +/** provides the possibility to find columns by their name. + + + <p>When several columns have the same name, then the value + of the first matching column will be returned. The column name option is + designed to be used when column names are used in the SQL + query. For columns that are NOT explicitly named in the query, it + is best to use column numbers. If column names are used, there is + no way for the programmer to guarantee that they actually refer to + the intended columns.</p> + */ +[ uik(FDBC3290-A81A-11d3-9ED50050-04D8BBD0), + ident("XColumnLocate", 1.0) ] +interface XColumnLocate: com::sun::star::uno::XInterface +{ + + // DocMerge from xml: method com::sun::star::sdbc::XColumnLocate::findColumn + /** maps the given Resultset column name to its ResultSet column index. + */ + long findColumn([in]string columnName) raises (SQLException); +}; + +//============================================================================= + +}; }; }; }; + +/*=========================================================================== + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:41 hjs + initial import + + Revision 1.3 2000/09/11 11:52:43 mi + documentation merged from XML + + Revision 1.1 1999/12/01 18:27:17 dg + #70248# XColumnLocate new + + Revision 1.1 1999/11/24 08:41:09 dg + new StarDataBaseConnectivity + +===========================================================================*/ +#endif diff --git a/offapi/com/sun/star/sdbc/XConnection.idl b/offapi/com/sun/star/sdbc/XConnection.idl new file mode 100644 index 000000000000..740fe4a43a12 --- /dev/null +++ b/offapi/com/sun/star/sdbc/XConnection.idl @@ -0,0 +1,377 @@ +/************************************************************************* + * + * $RCSfile: XConnection.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:57 $ + * + * 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_sdbc_XConnection_idl__ +#define __com_sun_star_sdbc_XConnection_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + + module com { module sun { module star { module container { +interface XNameAccess; +};};};}; + +#ifndef __com_sun_star_sdbc_SQLException_idl__ +#include <com/sun/star/sdbc/SQLException.idl> +#endif + +#ifndef __com_sun_star_sdbc_XCloseable_idl__ +#include <com/sun/star/sdbc/XCloseable.idl> +#endif + + module com { module sun { module star { module sdbc { + +interface XStatement; +interface XPreparedStatement; +interface XDatabaseMetaData; + + +// DocMerge from xml: interface com::sun::star::container::com::sun::star::sdbc::XConnection +/** represents a connection (session) with a specific + database. Within the context of a Connection, SQL statements are + executed and results are returned. + + + <p>A Connection's database is able to provide information + describing its tables, its supported SQL grammar, its stored + procedures, and the capabilities of this connection. This + information is obtained with the <code>getMetaData</code> method. + + </p>@see com::sun::star::sdbc::XDriverManager + @see com::sun::star::sdbc::XStatement + @see com::sun::star::sdbc::XDatabaseMetaData + */ +[ uik(D6B60231-9067-11d3-9EE00010-5AD7A5C4), ident("XConnection", 1.0) ] +interface XConnection: com::sun::star::sdbc::XCloseable +{ + + // DocMerge from xml: method com::sun::star::container::com::sun::star::sdbc::XConnection::createStatement + /** creates a new <code>Statement</code> object for sending + SQL statements to the database. + + + <p>SQL statements without parameters are normally + executed using Statement objects. If the same SQL statement + is executed many times, it is more efficient to use a + PreparedStatement <type scope="com::sun::star::sdbc">PreparedStatement</type>. + </p> + <p>Result sets created using the returned Statement will have + forward-only type, and read-only concurrency, by default. + </p> + <p>Escape processing for the SQL-Statement is enabled, by default. + </p> + */ + XStatement createStatement() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::container::com::sun::star::sdbc::XConnection::prepareStatement + /** creates a <code>PreparedStatement</code> object for sending + parameterized SQL statements to the database. + + + <p>A SQL statement with or without IN parameters can be + pre-compiled and stored in a PreparedStatement object. This + object can then be used to efficiently execute this statement + multiple times. + + </p> + <p> + <b>Note:</b> This method is optimized for handling + parametric SQL statements that benefit from precompilation. If + the driver supports precompilation, + the method <code>prepareStatement</code> will send + the statement to the database for precompilation. Some drivers + may not support precompilation. In this case, the statement may + not be sent to the database until the <code>PreparedStatement</code> is + executed. This has no direct effect on users; however, it does + affect which method throws certain SQLExceptions. + </p> + <p> Result sets created using the returned PreparedStatement will have + forward-only type and read-only concurrency, by default. + </p> + <p>Escape processing for the SQL-Statement is enabled, by default. + </p> + */ + XPreparedStatement prepareStatement([in]string sql) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::container::com::sun::star::sdbc::XConnection::prepareCall + /** creates a <code>CallableStatement</code> object for calling + database stored procedures. + + + <p>The CallableStatement provides methods for setting up its IN and OUT + parameters, and methods for executing the call to a stored procedure. + </p> + <p> + <b>Note:</b> This method is optimized for handling stored + procedure call statements. Some drivers may send the call + statement to the database when the method <code>prepareCall</code> + is done;<br> + others may wait until the CallableStatement is executed. This has no + direct effect on users; however, it does affect which method + throws certain SQLExceptions. + Result sets created using the returned CallableStatement will have + forward-only type and read-only concurrency, by default. + </p> + */ + XPreparedStatement prepareCall([in]string sql) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::container::com::sun::star::sdbc::XConnection::nativeSQL + /** converts the given SQL statement into the system's native SQL grammar. + A driver may convert the JDBC SQL grammar into its system's + native SQL grammar prior to sending it; this method returns the + native form of the statement that the driver would have sent. + */ + string nativeSQL([in]string sql) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::container::com::sun::star::sdbc::XConnection::setAutoCommit + /** sets this connection's auto-commit mode. + + + <p>If a connection is in auto-commit mode, then all its SQL + statements will be executed and committed as individual + transactions. Otherwise, its SQL statements are grouped into + transactions that are terminated by a call to either + the method <code>commit</code> or the method <code>rollback</code>. + By default, new connections are in auto-commit mode. + </p> + <p>The commit occurs when the statement completes or the next + execute occurs, whichever comes first. In the case of + statements returning a ResultSet, the statement completes when + the last row of the ResultSet has been retrieved or the + ResultSet has been closed. In advanced cases, a single + statement may return multiple results as well as output + parameter values. In these cases the commit occurs when all results and + output parameter values have been retrieved. + </p> + */ + void setAutoCommit([in] boolean autoCommit) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::container::com::sun::star::sdbc::XConnection::getAutoCommit + /** gets the current auto-commit state.@see setAutoCommit() + */ + [const] boolean getAutoCommit() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::container::com::sun::star::sdbc::XConnection::commit + /** makes all changes made since the previous commit/rollback + permanent and releases any database locks currently held + by the Connection. This method should be + used only when auto-commit mode has been disabled.@see setAutoCommit() + */ + void commit() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::container::com::sun::star::sdbc::XConnection::rollback + /** drops all changes made since the previous + commit/rollback and releases any database locks currently held + by this Connection. This method should be used only when auto-commit has been disabled.@see setAutoCommit() + */ + void rollback() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::container::com::sun::star::sdbc::XConnection::isClosed + /** tests to see if a connection is closed. + + + <p> + <b>Note:</b> A Connection is automatically closed if no one references it + anymore. Certain fatal errors also result in a closed Connection. + </p> + */ + [const] boolean isClosed() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::container::com::sun::star::sdbc::XConnection::getMetaData + /** gets the metadata regarding this connection's database. + + + <p>A Connection's database is able to provide information + describing its tables, its supported SQL grammar, its stored + procedures, the capabilities of this connection, and so on. This + information is made available through a DatabaseMetaData + object. + </p> + */ + XDatabaseMetaData getMetaData() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::container::com::sun::star::sdbc::XConnection::setReadOnly + /** puts this connection in read-only mode as a hint to enable + database optimizations. + + + <p> + <b>Note:</b> This method cannot be called while in the + middle of a transaction; calling setReadOnly with <true></true> does not + necessarily cause writes to be prohibited. + </p> + */ + void setReadOnly([in]boolean readOnly) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::container::com::sun::star::sdbc::XConnection::isReadOnly + /** tests to see if the connection is in read-only mode. + */ + [const] boolean isReadOnly() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::container::com::sun::star::sdbc::XConnection::setCatalog + /** sets a catalog name in order to select + a subspace of this Connection's database in which to work. + If the driver does not support catalogs, it will + silently ignore this request. + */ + void setCatalog([in]string catalog) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::container::com::sun::star::sdbc::XConnection::getCatalog + /** returns the Connection's current catalog name. + */ + [const] string getCatalog() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::container::com::sun::star::sdbc::XConnection::setTransactionIsolation + /** attempts to change the transaction isolation level to the one given. + + + <p>The constants defined in + <type scope="com::sun::star::sdbc">TransactionIsolation</type> are the possible + transaction isolation levels. + </p> + <p> + <b>Note:</b> This method cannot be called while + in the middle of a transaction. + </p>@see + com::sun::star::sdbc::XDatabaseMetaData::supportsTransactionIsolationLevel() + */ + void setTransactionIsolation([in]long level) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::container::com::sun::star::sdbc::XConnection::getTransactionIsolation + /** gets this Connection's current transaction isolation level. + */ + [const] long getTransactionIsolation() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::container::com::sun::star::sdbc::XConnection::getTypeMap + /** gets the type map object associated with this connection. Only drivers + how implement the custom type mapping facility will return an object otherwise + NULL could be returned. + + + <p>Unless the application has added an entry to the type map, the map + returned will be empty. + </p> + */ + [const] com::sun::star::container::XNameAccess getTypeMap() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::container::com::sun::star::sdbc::XConnection::setTypeMap + /** installs the given type map as the type map for this connection. + The type map will be used for the custom mapping of SQL structured types + and distinct types. + + + <p>Only if the driver supports custom type mapping the setting of a map is + allowed. + </p> + */ + void setTypeMap([in]com::sun::star::container::XNameAccess typeMap) + raises (SQLException); +}; + +//============================================================================= + +}; }; }; }; + +/*=========================================================================== + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:41 hjs + initial import + + Revision 1.8 2000/09/11 11:52:43 mi + documentation merged from XML + + Revision 1.6 2000/01/28 15:42:27 dg + #72175# documentation of getTypeMap + + Revision 1.5 2000/01/18 15:42:29 dg + #70278# Documentation completed + + Revision 1.4 1999/12/20 16:11:35 dg + #70278# changes in API + + Revision 1.3 1999/12/13 13:47:55 dg + #70278# XSQLErrorBroadcaster removed + + Revision 1.2 1999/11/24 11:33:26 dg + chk includes + + Revision 1.1 1999/11/24 08:41:04 dg + new StarDataBaseConnectivity + +===========================================================================*/ +#endif diff --git a/offapi/com/sun/star/sdbc/XDataSource.idl b/offapi/com/sun/star/sdbc/XDataSource.idl new file mode 100644 index 000000000000..7cbd2f99a0be --- /dev/null +++ b/offapi/com/sun/star/sdbc/XDataSource.idl @@ -0,0 +1,143 @@ +/************************************************************************* + * + * $RCSfile: XDataSource.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:57 $ + * + * 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_sdbc_XDataSource_idl__ +#define __com_sun_star_sdbc_XDataSource_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_sdbc_SQLException_idl__ +#include <com/sun/star/sdbc/SQLException.idl> +#endif + + module com { module sun { module star { module sdbc { + +interface XConnection; + + +// DocMerge from xml: interface com::sun::star::sdbc::XDataSource +/** is used for establishing connections via a factory which is identified + by its name. A DataSource object is typically registered by a naming service + provider. + */ +[ uik(C76294D1-96B3-11d3-9EE40010-5AD7A5C4), ident("XDataSource", 1.0) ] +interface XDataSource: com::sun::star::uno::XInterface +{ + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDataSource::getConnection + /** attempts to establish a database connection. + */ + XConnection getConnection([in]string user, [in]string password) + raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDataSource::setLoginTimeout + /** sets the maximum time in seconds that this data source will wait + while attempting to connect to a database. + + + <p>A value of zero specifies that the timeout is the default system + timeout if there is one; otherwise it specifies that there is no timeout. + When a DataSource object is created the login timeout is initially zero. + </p> + */ + void setLoginTimeout([in]long seconds) + raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDataSource::getLoginTimeout + /** gets the maximum time in seconds that this data source can wait + while attempting to connect to a database. + + + <p> A value of zero means that the timeout is the default system timeout + if there is one; otherwise it means that there is no timeout. When a + DataSource object is created the login timeout is initially zero. + </p> + */ + [const] long getLoginTimeout() raises (SQLException); +}; + +//============================================================================= + +}; }; }; }; + +/*=========================================================================== + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:41 hjs + initial import + + Revision 1.5 2000/09/11 11:52:43 mi + documentation merged from XML + + Revision 1.3 1999/12/14 12:05:45 dg + #70278# CompareBookmark removed + + Revision 1.2 1999/11/25 09:07:43 dg + adjustments + + Revision 1.1 1999/11/24 08:41:05 dg + new StarDataBaseConnectivity + +===========================================================================*/ +#endif diff --git a/offapi/com/sun/star/sdbc/XDatabaseMetaData.idl b/offapi/com/sun/star/sdbc/XDatabaseMetaData.idl new file mode 100644 index 000000000000..a2b44eced2ab --- /dev/null +++ b/offapi/com/sun/star/sdbc/XDatabaseMetaData.idl @@ -0,0 +1,2058 @@ +/************************************************************************* + * + * $RCSfile: XDatabaseMetaData.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:57 $ + * + * 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_sdbc_XDatabaseMetaData_idl__ +#define __com_sun_star_sdbc_XDatabaseMetaData_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_sdbc_SQLException_idl__ +#include <com/sun/star/sdbc/SQLException.idl> +#endif + + + module com { module sun { module star { module sdbc { + +interface XResultSet; +interface XConnection; + +// DocMerge from xml: interface com::sun::star::sdbc::XDatabaseMetaData +/** provides comprehensive information about the database as a whole. + + + <p>Many of the methods here return lists of information in + the form of <code>XResultSet</code> objects. + You can use the normal XResultSet methods such as getString and getInt + to retrieve the data from these XResultSets. If a given form of + metadata is not available, these methods should throw a SQLException. + </p> + <p>Some of these methods take arguments that are String patterns. These + arguments all have names such as fooPattern. Within a pattern String, "%" + means match any substring of 0 or more characters, and "_" means match + any one character. Only metadata entries matching the search pattern + are returned. If a search pattern argument is set to a null ref, + that argument's criteria will be dropped from the search. + </p> + <p>A <code>SQLException</code> will be thrown if a driver does not support + a meta data method. In the case of methods that return an XResultSet, + either an XResultSet (which may be empty) is returned or a + SQLException is thrown.</p> + */ +[ uik(D6B6024B-9067-11d3-9EE00010-5AD7A5C4), ident("XDatabaseMetaData", 1.0) ] +interface XDatabaseMetaData: com::sun::star::uno::XInterface +{ + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::allProceduresAreCallable + /** Can all the procedures returned by getProcedures be called by the + current user? + */ + [const] boolean allProceduresAreCallable() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::allTablesAreSelectable + /** Can all the tables returned by getTable be SELECTed by the + current user? + */ + [const] boolean allTablesAreSelectable() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getURL + /** returns the directory and filename of the database. + */ + [const] string getURL() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getUserName + /** returns the user name from this database connection. + */ + [const] string getUserName() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::isReadOnly + /** check, if the database in read-only mode. + */ + [const] boolean isReadOnly() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::nullsAreSortedHigh + /** Are NULL values sorted high ? + */ + [const] boolean nullsAreSortedHigh() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::nullsAreSortedLow + /** Are NULL values sorted low ? + */ + [const] boolean nullsAreSortedLow() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::nullsAreSortedAtStart + /** Are NULL values sorted at the start regardless of sort order? + */ + [const] boolean nullsAreSortedAtStart() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::nullsAreSortedAtEnd + /** Are NULL values sorted at the end regardless of sort order? + */ + [const] boolean nullsAreSortedAtEnd() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getDatabaseProductName + /** returns the name of the database product. + */ + [const] string getDatabaseProductName() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getDatabaseProductVersion + /** returns the version of the database product. + */ + [const] string getDatabaseProductVersion() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getDriverName + /** returns the name of the SDBC driver. + */ + [const] string getDriverName() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getDriverVersion + /** returns the version number of the SDBC driver. + */ + [const] string getDriverVersion() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getDriverMajorVersion + /** returns the JDBC driver major version number. + */ + [const] long getDriverMajorVersion(); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getDriverMinorVersion + /** returns the SDBC driver minor version number. + */ + [const] long getDriverMinorVersion(); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::usesLocalFiles + /** use the database local files to save the tables. + */ + [const] boolean usesLocalFiles() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::usesLocalFilePerTable + /** use the database one local file to save for each table. + */ + [const] boolean usesLocalFilePerTable() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsMixedCaseIdentifiers + /** use the database 'mixed case unquoted SQL identifiers' case sensitive. + */ + [const] boolean supportsMixedCaseIdentifiers() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::storesUpperCaseIdentifiers + /** Does the database treat mixed case unquoted SQL identifiers as + case insensitive and store them in upper case? + */ + [const] boolean storesUpperCaseIdentifiers() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::storesLowerCaseIdentifiers + /** Does the database treat mixed case unquoted SQL identifiers as + case insensitive and store them in lower case? + */ + [const] boolean storesLowerCaseIdentifiers() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::storesMixedCaseIdentifiers + /** Does the database treat mixed case unquoted SQL identifiers as + case insensitive and store them in mixed case? + */ + [const] boolean storesMixedCaseIdentifiers() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsMixedCaseQuotedIdentifiers + /** Does the database treat mixed case quoted SQL identifiers as + case sensitive and as a result store them in mixed case? + */ + [const] boolean supportsMixedCaseQuotedIdentifiers() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::storesUpperCaseQuotedIdentifiers + /** Does the database treat mixed case quoted SQL identifiers as + case insensitive and store them in upper case? + */ + [const] boolean storesUpperCaseQuotedIdentifiers() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::storesLowerCaseQuotedIdentifiers + /** Does the database treat mixed case quoted SQL identifiers as + case insensitive and store them in lower case? + */ + [const] boolean storesLowerCaseQuotedIdentifiers() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::storesMixedCaseQuotedIdentifiers + /** Does the database treat mixed case quoted SQL identifiers as + case insensitive and store them in mixed case? + */ + [const] boolean storesMixedCaseQuotedIdentifiers() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getIdentifierQuoteString + /** What's the string used to quote SQL identifiers? + This returns a space " " if identifier quoting isn't supported. + */ + [const] string getIdentifierQuoteString() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getSQLKeywords + /** Gets a comma-separated list of all a database's SQL keywords + that are NOT also SQL92 keywords. + */ + [const] string getSQLKeywords() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getNumericFunctions + /** Gets a comma-separated list of math functions. These are the + X/Open CLI math function names used in the SDBC function escape + clause. + */ + [const] string getNumericFunctions() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getStringFunctions + /** Gets a comma-separated list of string functions. These are the + X/Open CLI string function names used in the SDBC function escape + clause. + */ + [const] string getStringFunctions() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getSystemFunctions + /** Gets a comma-separated list of system functions. These are the + X/Open CLI system function names used in the SDBC function escape + clause. + */ + [const] string getSystemFunctions() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getTimeDateFunctions + /** Gets a comma-separated list of time and date functions. + */ + [const] string getTimeDateFunctions() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getSearchStringEscape + /** Gets the string that can be used to escape wildcard characters. + This is the string that can be used to escape '_' or '%' in + the string pattern style catalog search parameters. + + + <p>The '_' character represents any single character. + </p> + <p>The '%' character represents any sequence of zero or + more characters. + </p> + */ + [const] string getSearchStringEscape() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getExtraNameCharacters + /** Gets all the "extra" characters that can be used in unquoted + identifier names (those beyond a-z, A-Z, 0-9 and _). + */ + [const] string getExtraNameCharacters() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsAlterTableWithAddColumn + /** support the Database "ALTER TABLE" with add column ? + */ + [const] boolean supportsAlterTableWithAddColumn() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsAlterTableWithDropColumn + /** support the Database "ALTER TABLE" with drop column ? + */ + [const] boolean supportsAlterTableWithDropColumn() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsColumnAliasing + /** support the Database column aliasing ? + + + <p>The SQL AS clause can be used to provide names for + computed columns or to provide alias names for columns as required. + </p> + */ + [const] boolean supportsColumnAliasing() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::nullPlusNonNullIsNull + /** are concatenations between NULL and non-NULL values NULL? + */ + [const] boolean nullPlusNonNullIsNull() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsTypeConversion + /** Support the Database the CONVERT function between SQL types ? + */ + [const] boolean supportsTypeConversion() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsConvert + /** Support the Database the CONVERT between the given SQL types ? + */ + [const] boolean supportsConvert([in]long fromType, [in]long toType) + raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsTableCorrelationNames + /** Are table correlation names supported? + */ + [const] boolean supportsTableCorrelationNames() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsDifferentTableCorrelationNames + /** If table correlation names are supported, are they restricted + to be different from the names of the tables? + */ + [const] boolean supportsDifferentTableCorrelationNames() + raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsExpressionsInOrderBy + /** Are expressions in "ORDER BY" lists supported? + */ + [const] boolean supportsExpressionsInOrderBy() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsOrderByUnrelated + /** Can an "ORDER BY" clause use columns not in the SELECT statement? + */ + [const] boolean supportsOrderByUnrelated() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsGroupBy + /** Is some form of "GROUP BY" clause supported? + */ + [const] boolean supportsGroupBy() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsGroupByUnrelated + /** Can a "GROUP BY" clause use columns not in the SELECT? + */ + [const] boolean supportsGroupByUnrelated() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsGroupByBeyondSelect + /** Can a "GROUP BY" clause add columns not in the SELECT + provided it specifies all the columns in the SELECT? + */ + [const] boolean supportsGroupByBeyondSelect() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsLikeEscapeClause + /** Is the escape character in "LIKE" clauses supported? + */ + [const] boolean supportsLikeEscapeClause() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsMultipleResultSets + /** Are multiple XResultSets from a single execute supported? + */ + [const] boolean supportsMultipleResultSets() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsMultipleTransactions + /** Can we have multiple transactions open at once (on different + connections)? + */ + [const] boolean supportsMultipleTransactions() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsNonNullableColumns + /** Can columns be defined as non-nullable? + */ + [const] boolean supportsNonNullableColumns() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsMinimumSQLGrammar + /** support the Database ODBC Minimum SQL grammar ? + */ + [const] boolean supportsMinimumSQLGrammar() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsCoreSQLGrammar + /** support the Database ODBC Core SQL grammar ? + */ + [const] boolean supportsCoreSQLGrammar() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsExtendedSQLGrammar + /** support the Database ODBC Extended SQL grammar ? + */ + [const] boolean supportsExtendedSQLGrammar() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsANSI92EntryLevelSQL + /** support the Database ANSI92 entry level SQL grammar ? + */ + [const] boolean supportsANSI92EntryLevelSQL() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsANSI92IntermediateSQL + /** Support the Database ANSI92 intermediate SQL grammar ? + */ + [const] boolean supportsANSI92IntermediateSQL() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsANSI92FullSQL + /** Support the Database ANSI92 full SQL grammar ? + */ + [const] boolean supportsANSI92FullSQL() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsIntegrityEnhancementFacility + /** support the Database SQL Integrity Enhancement Facility ? + */ + [const] boolean supportsIntegrityEnhancementFacility() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsOuterJoins + /** Is some form of outer join supported? + */ + [const] boolean supportsOuterJoins() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsFullOuterJoins + /** Are full nested outer joins supported? + */ + [const] boolean supportsFullOuterJoins() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsLimitedOuterJoins + /** Is there limited support for outer joins? (This will be true + if supportFullOuterJoins is true.) + */ + [const] boolean supportsLimitedOuterJoins() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getSchemaTerm + /** return the database vendor's preferred term for "schema" + */ + [const] string getSchemaTerm() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getProcedureTerm + /** return the database vendor's preferred term for "procedure" + */ + [const] string getProcedureTerm() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getCatalogTerm + /** return the database vendor's preferred term for "catalog" + */ + [const] string getCatalogTerm() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::isCatalogAtStart + /** Does a catalog appear at the start of a qualified table name? + (Otherwise it appears at the end) + */ + [const] boolean isCatalogAtStart() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getCatalogSeparator + /** return the separator between catalog and table name + */ + [const] string getCatalogSeparator() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsSchemasInDataManipulation + /** Can a schema name be used in a data manipulation statement? + */ + [const] boolean supportsSchemasInDataManipulation() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsSchemasInProcedureCalls + /** Can a schema name be used in a procedure call statement? + */ + [const] boolean supportsSchemasInProcedureCalls() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsSchemasInTableDefinitions + /** Can a schema name be used in a table definition statement? + */ + [const] boolean supportsSchemasInTableDefinitions() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsSchemasInIndexDefinitions + /** Can a schema name be used in an index definition statement? + */ + [const] boolean supportsSchemasInIndexDefinitions() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsSchemasInPrivilegeDefinitions + /** Can a schema name be used in a privilege definition statement? + */ + [const] boolean supportsSchemasInPrivilegeDefinitions() + raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsCatalogsInDataManipulation + /** Can a catalog name be used in a data manipulation statement? + */ + [const] boolean supportsCatalogsInDataManipulation() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsCatalogsInProcedureCalls + /** Can a catalog name be used in a procedure call statement? + */ + [const] boolean supportsCatalogsInProcedureCalls() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsCatalogsInTableDefinitions + /** Can a catalog name be used in a table definition statement? + */ + [const] boolean supportsCatalogsInTableDefinitions() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsCatalogsInIndexDefinitions + /** Can a catalog name be used in an index definition statement? + */ + [const] boolean supportsCatalogsInIndexDefinitions() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsCatalogsInPrivilegeDefinitions + /** Can a catalog name be used in a privilege definition statement? + */ + [const] boolean supportsCatalogsInPrivilegeDefinitions() + raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsPositionedDelete + /** Is positioned DELETE supported? + */ + [const] boolean supportsPositionedDelete() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsPositionedUpdate + /** Is positioned UPDATE supported? + */ + [const] boolean supportsPositionedUpdate() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsSelectForUpdate + /** Is SELECT for UPDATE supported? + */ + [const] boolean supportsSelectForUpdate() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsStoredProcedures + /** Are stored procedure calls using the stored procedure escape + syntax supported? + */ + [const] boolean supportsStoredProcedures() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsSubqueriesInComparisons + /** Are subqueries in comparison expressions supported? + */ + [const] boolean supportsSubqueriesInComparisons() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsSubqueriesInExists + /** Are subqueries in 'exists' expressions supported? + */ + [const] boolean supportsSubqueriesInExists() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsSubqueriesInIns + /** Are subqueries in 'in' statements supported? + */ + [const] boolean supportsSubqueriesInIns() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsSubqueriesInQuantifieds + /** Are subqueries in quantified expressions supported? + */ + [const] boolean supportsSubqueriesInQuantifieds() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsCorrelatedSubqueries + /** Are correlated subqueries supported? + */ + [const] boolean supportsCorrelatedSubqueries() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsUnion + /** Is SQL UNION supported? + */ + [const] boolean supportsUnion() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsUnionAll + /** Is SQL UNION ALL supported? + */ + [const] boolean supportsUnionAll() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsOpenCursorsAcrossCommit + /** Can cursors remain open across commits? + */ + [const] boolean supportsOpenCursorsAcrossCommit() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsOpenCursorsAcrossRollback + /** Can cursors remain open across rollbacks? + */ + [const] boolean supportsOpenCursorsAcrossRollback() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsOpenStatementsAcrossCommit + /** Can statements remain open across commits? + */ + [const] boolean supportsOpenStatementsAcrossCommit() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsOpenStatementsAcrossRollback + /** Can statements remain open across rollbacks? + */ + [const] boolean supportsOpenStatementsAcrossRollback() + raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getMaxBinaryLiteralLength + /** return the maximal number of hex characters in an inline binary literal + */ + [const] long getMaxBinaryLiteralLength() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getMaxCharLiteralLength + /** return the max length for a character literal + */ + [const] long getMaxCharLiteralLength() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getMaxColumnNameLength + /** return the limit on column name length + */ + [const] long getMaxColumnNameLength() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getMaxColumnsInGroupBy + /** return the maximum number of columns in a "GROUP BY" clause + */ + [const] long getMaxColumnsInGroupBy() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getMaxColumnsInIndex + /** return the maximum number of columns allowed in an index + */ + [const] long getMaxColumnsInIndex() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getMaxColumnsInOrderBy + /** return the maximum number of columns in an "ORDER BY" clause + */ + [const] long getMaxColumnsInOrderBy() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getMaxColumnsInSelect + /** return the maximum number of columns in a "SELECT" list + */ + [const] long getMaxColumnsInSelect() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getMaxColumnsInTable + /** return the maximum number of columns in a table + */ + [const] long getMaxColumnsInTable() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getMaxConnections + /** return the number of active connections at a time to this database. + */ + [const] long getMaxConnections() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getMaxCursorNameLength + /** return the maximum cursor name length + */ + [const] long getMaxCursorNameLength() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getMaxIndexLength + /** return the maximum length of an index (in bytes) + */ + [const] long getMaxIndexLength() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getMaxSchemaNameLength + /** return the maximum length allowed for a schema name + */ + [const] long getMaxSchemaNameLength() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getMaxProcedureNameLength + /** return the maximum length of a procedure name + */ + [const] long getMaxProcedureNameLength() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getMaxCatalogNameLength + /** return the maximum length of a catalog name + */ + [const] long getMaxCatalogNameLength() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getMaxRowSize + /** return the maximum length of a single row. + */ + [const] long getMaxRowSize() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::doesMaxRowSizeIncludeBlobs + /** Did getMaxRowSize() include LONGVARCHAR and LONGVARBINARY + blobs? + */ + [const] boolean doesMaxRowSizeIncludeBlobs() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getMaxStatementLength + /** return the maximum length of a SQL statement + */ + [const] long getMaxStatementLength() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getMaxStatements + /** return the maximal number of open active statements at one time to this database + */ + [const] long getMaxStatements() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getMaxTableNameLength + /** return the maximum length of a table name + */ + [const] long getMaxTableNameLength() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getMaxTablesInSelect + /** return the maximum number of tables in a SELECT statement + */ + [const] long getMaxTablesInSelect() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getMaxUserNameLength + /** return the maximum length of a user name + */ + [const] long getMaxUserNameLength() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getDefaultTransactionIsolation + /** return the database default transaction isolation level. + The values are defined in <type scope="com::sun::star::sdbc">TransactionIsolation</type>.@see com::sun::star::sdbc::XConnection + */ + [const] long getDefaultTransactionIsolation() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsTransactions + /** support the Database transactions ? + If not, invoking the method <code>commit</code> is a noop and the + isolation level is TransactionIsolation_NONE. + */ + [const] boolean supportsTransactions() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsTransactionIsolationLevel + /** Does this database support the given transaction isolation level?@see com::sun::star::sdbc::Connection + */ + [const] boolean supportsTransactionIsolationLevel([in]long level) + raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsDataDefinitionAndDataManipulationTransactions + /** support the Database both data definition and data manipulation statements + within a transaction? + */ + [const] boolean supportsDataDefinitionAndDataManipulationTransactions() + raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsDataManipulationTransactionsOnly + /** are only data manipulation statements within a transaction + supported? + */ + [const] boolean supportsDataManipulationTransactionsOnly() + raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::dataDefinitionCausesTransactionCommit + /** does a data definition statement within a transaction force the + transaction to commit? + */ + [const] boolean dataDefinitionCausesTransactionCommit() + raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::dataDefinitionIgnoredInTransactions + /** is a data definition statement within a transaction ignored? + */ + [const] boolean dataDefinitionIgnoredInTransactions() + raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getProcedures + /** Gets a description of the stored procedures available in a + catalog. + + + <p>Only procedure descriptions matching the schema and + procedure name criteria are returned. They are ordered by + PROCEDURE_SCHEM, and PROCEDURE_NAME. + </p> + <p>Each procedure description has the the following columns: + </p> + <ol> + <li> + <b>PROCEDURE_CAT</b> string =&gt; procedure catalog (may be null) + </li> + <li> + <b>PROCEDURE_SCHEM</b> string =&gt; procedure schema (may be null) + </li> + <li> + <b>PROCEDURE_NAME</b> string =&gt; procedure name + </li> + <li> reserved for future use + </li> + <li> reserved for future use + </li> + <li> reserved for future use + </li> + <li> + <b>REMARKS</b> string =&gt; explanatory comment on the procedure + </li> + <li> + <b>PROCEDURE_TYPE</b> short =&gt; kind of procedure: + <ul> + <li> UNKNOWN - May return a result + </li> + <li> NO - Does not return a result + </li> + <li> RETURN - Returns a result + </li> + </ul> + </li> + </ol> + */ + XResultSet getProcedures([in]any catalog, [in]string schemaPattern, + [in]string procedureNamePattern) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getProcedureColumns + /** gets a description of a catalog's stored procedure parameters + and result columns. + + + <p>Only descriptions matching the schema, procedure and + parameter name criteria are returned. They are ordered by + PROCEDURE_SCHEM and PROCEDURE_NAME. Within this, the return value, + if any, is first. Next are the parameter descriptions in call + order. The column descriptions follow in column number order. + </p> + <p>Each row in the XResultSet is a parameter description or + column description with the following fields: + </p> + <ol> + <li> + <b>PROCEDURE_CAT</b> string =&gt; procedure catalog (may be null) + </li> + <li> + <b>PROCEDURE_SCHEM</b> string =&gt; procedure schema (may be null) + </li> + <li> + <b>PROCEDURE_NAME</b> string =&gt; procedure name + </li> + <li> + <b>COLUMN_NAME</b> string =&gt; column/parameter name + </li> + <li> + <b>COLUMN_TYPE</b> Short =&gt; kind of column/parameter: + <ul> + <li> UNKNOWN - nobody knows + </li> + <li> IN - IN parameter + </li> + <li> INOUT - INOUT parameter + </li> + <li> OUT - OUT parameter + </li> + <li> RETURN - procedure return value + </li> + <li> RESULT - result column in XResultSet + </li> + </ul> + </li> + <li> + <b>DATA_TYPE</b> short =&gt; SQL type from java.sql.Types + </li> + <li> + <b>TYPE_NAME</b> string =&gt; SQL type name, for a UDT type the + type name is fully qualified + </li> + <li> + <b>PRECISION</b> long =&gt; precision + </li> + <li> + <b>LENGTH</b> long =&gt; length in bytes of data + </li> + <li> + <b>SCALE</b> short =&gt; scale + </li> + <li> + <b>RADIX</b> short =&gt; radix + </li> + <li> + <b>NULLABLE</b> short =&gt; can it contain NULL? + <ul> + <li> NO_NULLS - does not allow NULL values + </li> + <li> NULLABLE - allows NULL values + </li> + <li> NULLABLE_UNKNOWN - nullability unknown + </li> + </ul> + </li> + <li> + <b>REMARKS</b> string =&gt; comment describing parameter/column + </li> + </ol> + <p> + <b>Note:</b> Some databases may not return the column + descriptions for a procedure. Additional columns beyond + REMARKS can be defined by the database. + </p> + */ + XResultSet getProcedureColumns([in]any catalog, [in]string schemaPattern, + [in]string procedureNamePattern, + [in]string columnNamePattern) + raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getTables + /** gets a description of tables available in a catalog. + + + <p>Only table descriptions matching the catalog, schema, table + name and type criteria are returned. They are ordered by + TABLE_TYPE, TABLE_SCHEM and TABLE_NAME. + </p> + <p>Each table description has the following columns: + </p> + <ol> + <li> + <b>TABLE_CAT</b> string =&gt; table catalog (may be null) + </li> + <li> + <b>TABLE_SCHEM</b> string =&gt; table schema (may be null) + </li> + <li> + <b>TABLE_NAME</b> string =&gt; table name + </li> + <li> + <b>TABLE_TYPE</b> string =&gt; table type. Typical types are "TABLE", + "VIEW", "SYSTEM TABLE", "GLOBAL TEMPORARY", + "LOCAL TEMPORARY", "ALIAS", "SYNONYM". + </li> + <li> + <b>REMARKS</b> string =&gt; explanatory comment on the table + </li> + </ol> + <p> + <b>Note:</b> Some databases may not return information for + all tables. + </p> + */ + XResultSet getTables([in]any catalog, [in]string schemaPattern, + [in]string tableNamePattern, [in]sequence<string> types) + raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getSchemas + /** Gets the schema names available in this database. The results + are ordered by schema name. + + + <p>The schema column is: + </p> + <ol> + <li> + <b>TABLE_SCHEM</b> string =&gt; schema name + </li> + </ol> + */ + XResultSet getSchemas() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getCatalogs + /** gets the catalog names available in this database. The results + are ordered by catalog name. + + + <p>The catalog column is: + </p> + <ol> + <li> + <b>TABLE_CAT</b> string =&gt; catalog name + </li> + </ol> + */ + XResultSet getCatalogs() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getTableTypes + /** gets the table types available in this database. The results + are ordered by table type. + + + <p>The table type is: + </p> + <ol> + <li> + <b>TABLE_TYPE</b> string =&gt; table type. Typical types are "TABLE", + "VIEW", "SYSTEM TABLE", "GLOBAL TEMPORARY", + "LOCAL TEMPORARY", "ALIAS", "SYNONYM". + </li> + </ol> + */ + XResultSet getTableTypes() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getColumns + /** gets a description of table columns available in + the specified catalog. + + + <p>Only column descriptions matching the catalog, schema, table + and column name criteria are returned. They are ordered by + TABLE_SCHEM, TABLE_NAME and ORDINAL_POSITION. + </p> + <p>Each column description has the following columns: + </p> + <ol> + <li> + <b>TABLE_CAT</b> string =&gt; table catalog (may be null) + </li> + <li> + <b>TABLE_SCHEM</b> string =&gt; table schema (may be null) + </li> + <li> + <b>TABLE_NAME</b> string =&gt; table name + </li> + <li> + <b>COLUMN_NAME</b> string =&gt; column name + </li> + <li> + <b>DATA_TYPE</b> short =&gt; SQL type from java.sql.Types + </li> + <li> + <b>TYPE_NAME</b> string =&gt; Data source dependent type name, + for a UDT the type name is fully qualified + </li> + <li> + <b>COLUMN_SIZE</b> long =&gt; column size. For char or date + types this is the maximum number of characters, for numeric or + decimal types this is precision. + </li> + <li> + <b>BUFFER_LENGTH</b> is not used. + </li> + <li> + <b>DECIMAL_DIGITS</b> long =&gt; the number of fractional digits + </li> + <li> + <b>NUM_PREC_RADIX</b> long =&gt; Radix (typically either 10 or 2) + </li> + <li> + <b>NULLABLE</b> long =&gt; is NULL allowed? + <ul> + <li> NO_NULLS - might not allow NULL values + </li> + <li> NULABLE - definitely allows NULL values + </li> + <li> NULLABLE_UNKNOWN - nullability unknown + </li> + </ul> + </li> + <li> + <b>REMARKS</b> string =&gt; comment describing column (may be null) + </li> + <li> + <b>COLUMN_DEF</b> string =&gt; default value (may be null) + </li> + <li> + <b>SQL_DATA_TYPE</b> long =&gt; unused + </li> + <li> + <b>SQL_DATETIME_SUB</b> long =&gt; unused + </li> + <li> + <b>CHAR_OCTET_LENGTH</b> long =&gt; for char types the + maximum number of bytes in the column + </li> + <li> + <b>ORDINAL_POSITION</b> int =&gt; index of column in table + (starting at 1) + </li> + <li> + <b>IS_NULLABLE</b> string =&gt; "NO" means column definitely + does not allow NULL values; "YES" means the column might + allow NULL values. An empty string means nobody knows. + </li> + </ol> + */ + XResultSet getColumns([in]any catalog, [in]string schemaPattern, + [in]string tableNamePattern, [in]string columnNamePattern) + raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getColumnPrivileges + /** gets a description of the access rights for a table's columns. + + + <p>Only privileges matching the column name criteria are + returned. They are ordered by COLUMN_NAME and PRIVILEGE. + </p> + <p>Each privilige description has the following columns: + </p> + <ol> + <li> + <b>TABLE_CAT</b> string =&gt; table catalog (may be null) + </li> + <li> + <b>TABLE_SCHEM</b> string =&gt; table schema (may be null) + </li> + <li> + <b>TABLE_NAME</b> string =&gt; table name + </li> + <li> + <b>COLUMN_NAME</b> string =&gt; column name + </li> + <li> + <b>GRANTOR</b> =&gt; grantor of access (may be null) + </li> + <li> + <b>GRANTEE</b> string =&gt; grantee of access + </li> + <li> + <b>PRIVILEGE</b> string =&gt; name of access (SELECT, + INSERT, UPDATE, REFERENCES, ...) + </li> + <li> + <b>IS_GRANTABLE</b> string =&gt; "YES" if grantee is permitted + to grant to others; "NO" if not; null if unknown + </li> + </ol> + */ + XResultSet getColumnPrivileges([in]any catalog, [in]string schema, + [in]string table, [in]string columnNamePattern) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getTablePrivileges + /** gets a description of the access rights for each table available + in a catalog. Note that a table privilege applies to one or + more columns in the table. It would be wrong to assume that + this priviledge applies to all columns (this may be true for + some systems but is not true for all.) + + + <p>Only privileges matching the schema and table name + criteria are returned. They are ordered by TABLE_SCHEM, + TABLE_NAME, and PRIVILEGE. + </p> + <p>Each privilige description has the following columns: + </p> + <ol> + <li> + <b>TABLE_CAT</b> string =&gt; table catalog (may be null) + </li> + <li> + <b>TABLE_SCHEM</b> string =&gt; table schema (may be null) + </li> + <li> + <b>TABLE_NAME</b> string =&gt; table name + </li> + <li> + <b>GRANTOR</b> =&gt; grantor of access (may be null) + </li> + <li> + <b>GRANTEE</b> string =&gt; grantee of access + </li> + <li> + <b>PRIVILEGE</b> string =&gt; name of access (SELECT, + INSERT, UPDATE, REFERENCES, ...) + </li> + <li> + <b>IS_GRANTABLE</b> string =&gt; "YES" if grantee is permitted + to grant to others; "NO" if not; null if unknown + </li> + </ol> + */ + XResultSet getTablePrivileges([in]any catalog, [in]string schemaPattern, + [in]string tableNamePattern) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getBestRowIdentifier + /** gets a description of a table's optimal set of columns that + uniquely identifies a row. They are ordered by SCOPE. + + + <p>Each column description has the following columns: + </p> + <ol> + <li> + <b>SCOPE</b> short =&gt; actual scope of result + <ul> + <li> TEMPORARY - very temporary, while using row + </li> + <li> TRANSACTION - valid for remainder of current transaction + </li> + <li> SESSION - valid for remainder of current session + </li> + </ul> + </li> + <li> + <b>COLUMN_NAME</b> string =&gt; column name + </li> + <li> + <b>DATA_TYPE</b> short =&gt; SQL data type from java.sql.Types + </li> + <li> + <b>TYPE_NAME</b> string =&gt; Data source dependent type name, + for a UDT the type name is fully qualified + </li> + <li> + <b>COLUMN_SIZE</b> long =&gt; precision + </li> + <li> + <b>BUFFER_LENGTH</b> long =&gt; not used + </li> + <li> + <b>DECIMAL_DIGITS</b> short =&gt; scale + </li> + <li> + <b>PSEUDO_COLUMN</b> short =&gt; is this a pseudo column + like an Oracle ROWID + <ul> + <li> UNKNOWN - may or may not be pseudo column + </li> + <li> NOT_PSEUDO - is NOT a pseudo column + </li> + <li> PSEUDO - is a pseudo column + </li> + </ul> + </li> + </ol> + */ + XResultSet getBestRowIdentifier([in]any catalog, [in]string schema, + [in]string table, [in]long scope, [in] boolean nullable) + raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getVersionColumns + /** gets a description of a table's columns that are automatically + updated when any value in a row is updated. They are + unordered. + + + <p>Each column description has the following columns: + </p> + <ol> + <li> + <b>SCOPE</b> short =&gt; is not used + </li> + <li> + <b>COLUMN_NAME</b> string =&gt; column name + </li> + <li> + <b>DATA_TYPE</b> short =&gt; SQL data type from java.sql.Types + </li> + <li> + <b>TYPE_NAME</b> string =&gt; Data source dependent type name + </li> + <li> + <b>COLUMN_SIZE</b> long =&gt; precision + </li> + <li> + <b>BUFFER_LENGTH</b> long =&gt; length of column value in bytes + </li> + <li> + <b>DECIMAL_DIGITS</b> short =&gt; scale + </li> + <li> + <b>PSEUDO_COLUMN</b> short =&gt; is this a pseudo column + like an Oracle ROWID + <ul> + <li> UNKNOWN - may or may not be pseudo column + </li> + <li> NOT_PSEUDO - is NOT a pseudo column + </li> + <li> PSEUDO - is a pseudo column + </li> + </ul> + </li> + </ol> + */ + XResultSet getVersionColumns([in]any catalog, [in]string schema, + [in]string table) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getPrimaryKeys + /** gets a description of a table's primary key columns. They + are ordered by COLUMN_NAME. + + + <p>Each primary key column description has the following columns: + </p> + <ol> + <li> + <b>TABLE_CAT</b> string =&gt; table catalog (may be null) + </li> + <li> + <b>TABLE_SCHEM</b> string =&gt; table schema (may be null) + </li> + <li> + <b>TABLE_NAME</b> string =&gt; table name + </li> + <li> + <b>COLUMN_NAME</b> string =&gt; column name + </li> + <li> + <b>KEY_SEQ</b> short =&gt; sequence number within primary key + </li> + <li> + <b>PK_NAME</b> string =&gt; primary key name (may be null) + </li> + </ol> + */ + XResultSet getPrimaryKeys([in]any catalog, [in]string schema, + [in]string table) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getImportedKeys + /** gets a description of the primary key columns that are + referenced by a table's foreign key columns (the primary keys + imported by a table). They are ordered by PKTABLE_CAT, + PKTABLE_SCHEM, PKTABLE_NAME, and KEY_SEQ. + + + <p>Each primary key column description has the following columns: + </p> + <ol> + <li> + <b>PKTABLE_CAT</b> string =&gt; primary key table catalog + being imported (may be null) + </li> + <li> + <b>PKTABLE_SCHEM</b> string =&gt; primary key table schema + being imported (may be null) + </li> + <li> + <b>PKTABLE_NAME</b> string =&gt; primary key table name + being imported + </li> + <li> + <b>PKCOLUMN_NAME</b> string =&gt; primary key column name + eing imported + </li> + <li> + <b>FKTABLE_CAT</b> string =&gt; foreign key table catalog (may be null) + </li> + <li> + <b>FKTABLE_SCHEM</b> string =&gt; foreign key table schema (may be null) + </li> + <li> + <b>FKTABLE_NAME</b> string =&gt; foreign key table name + </li> + <li> + <b>FKCOLUMN_NAME</b> string =&gt; foreign key column name + </li> + <li> + <b>KEY_SEQ</b> short =&gt; sequence number within foreign key + </li> + <li> + <b>UPDATE_RULE</b> short =&gt; What happens to + foreign key when primary is updated: + <ul> + <li> importedNoAction - do not allow update of primary + key if it has been imported + </li> + <li> importedKeyCascade - change imported key to agree + with primary key update + </li> + <li> importedKeySetNull - change imported key to NULL if + its primary key has been updated + </li> + <li> importedKeySetDefault - change imported key to default values + if its primary key has been updated + </li> + <li> importedKeyRestrict - same as importedKeyNoAction + (for ODBC 2.x compatibility) + </li> + </ul> + </li> + <li> + <b>DELETE_RULE</b> short =&gt; What happens to + the foreign key when primary is deleted. + <ul> + <li> importedKeyNoAction - do not allow delete of primary + key if it has been imported + </li> + <li> importedKeyCascade - delete rows that import a deleted key + </li> + <li> importedKeySetNull - change imported key to NULL if + its primary key has been deleted + </li> + <li> importedKeyRestrict - same as importedKeyNoAction + (for ODBC 2.x compatibility) + </li> + <li> importedKeySetDefault - change imported key to default if + its primary key has been deleted + </li> + </ul> + </li> + <li> + <b>FK_NAME</b> string =&gt; foreign key name (may be null) + </li> + <li> + <b>PK_NAME</b> string =&gt; primary key name (may be null) + </li> + <li> + <b>DEFERRABILITY</b> short =&gt; can the evaluation of foreign key + constraints be deferred until commit + <ul> + <li> importedKeyInitiallyDeferred - see SQL92 for definition + </li> + <li> importedKeyInitiallyImmediate - see SQL92 for definition + </li> + <li> importedKeyNotDeferrable - see SQL92 for definition + </li> + </ul> + </li> + </ol> + */ + XResultSet getImportedKeys([in]any catalog, [in]string schema, + [in]string table) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getExportedKeys + /** gets a description of the foreign key columns that reference a + table's primary key columns (the foreign keys exported by a + table). They are ordered by FKTABLE_CAT, FKTABLE_SCHEM, + FKTABLE_NAME, and KEY_SEQ. + + + <p>Each foreign key column description has the following columns: + </p> + <ol> + <li> + <b>PKTABLE_CAT</b> string =&gt; primary key table catalog (may be null) + </li> + <li> + <b>PKTABLE_SCHEM</b> string =&gt; primary key table schema (may be null) + </li> + <li> + <b>PKTABLE_NAME</b> string =&gt; primary key table name + </li> + <li> + <b>PKCOLUMN_NAME</b> string =&gt; primary key column name + </li> + <li> + <b>FKTABLE_CAT</b> string =&gt; foreign key table catalog (may be null) + being exported (may be null) + </li> + <li> + <b>FKTABLE_SCHEM</b> string =&gt; foreign key table schema (may be null) + being exported (may be null) + </li> + <li> + <b>FKTABLE_NAME</b> string =&gt; foreign key table name + being exported + </li> + <li> + <b>FKCOLUMN_NAME</b> string =&gt; foreign key column name + being exported + </li> + <li> + <b>KEY_SEQ</b> short =&gt; sequence number within foreign key + </li> + <li> + <b>UPDATE_RULE</b> short =&gt; What happens to + foreign key when primary is updated: + <ul> + <li> NO_ACTION - do not allow update of primary + key if it has been imported + </li> + <li> CASCADE - change imported key to agree + with primary key update + </li> + <li> SET_NULL - change imported key to NULL if + its primary key has been updated + </li> + <li> SET_DEFAULT - change imported key to default values + if its primary key has been updated + </li> + <li> RESTRICT - same as importedKeyNoAction + (for ODBC 2.x compatibility) + </li> + </ul> + </li> + <li> + <b>DELETE_RULE</b> short =&gt; What happens to + the foreign key when primary is deleted. + <ul> + <li> NO_ACTION - do not allow delete of primary + key if it has been imported + </li> + <li> CASCADE - delete rows that import a deleted key + </li> + <li> SET_NULL - change imported key to NULL if + its primary key has been deleted + </li> + <li> RESTRICT - same as importedKeyNoAction + (for ODBC 2.x compatibility) + </li> + <li> SET_DEFAULT - change imported key to default if + its primary key has been deleted + </li> + </ul> + </li> + <li> + <b>FK_NAME</b> string =&gt; foreign key name (may be null) + </li> + <li> + <b>PK_NAME</b> string =&gt; primary key name (may be null) + </li> + <li> + <b>DEFERRABILITY</b> short =&gt; can the evaluation of foreign key + constraints be deferred until commit + <ul> + <li> INITIALLY_DEFERRED - see SQL92 for definition + </li> + <li> INITIALLY_IMMEDIATE - see SQL92 for definition + </li> + <li> NONE - see SQL92 for definition + </li> + </ul> + </li> + </ol> + */ + XResultSet getExportedKeys([in]any catalog, [in]string schema, + [in]string table) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getCrossReference + /** gets a description of the foreign key columns in the foreign key + table that reference the primary key columns of the primary key + table (describe how one table imports another's key.) This + should normally return a single foreign key/primary key pair + (most tables only import a foreign key from a table once.) They + are ordered by FKTABLE_CAT, FKTABLE_SCHEM, FKTABLE_NAME, and + KEY_SEQ. + + + <p>Each foreign key column description has the following columns: + </p> + <ol> + <li> + <b>PKTABLE_CAT</b> string =&gt; primary key table catalog (may be null) + </li> + <li> + <b>PKTABLE_SCHEM</b> string =&gt; primary key table schema (may be null) + </li> + <li> + <b>PKTABLE_NAME</b> string =&gt; primary key table name + </li> + <li> + <b>PKCOLUMN_NAME</b> string =&gt; primary key column name + </li> + <li> + <b>FKTABLE_CAT</b> string =&gt; foreign key table catalog (may be null) + being exported (may be null) + </li> + <li> + <b>FKTABLE_SCHEM</b> string =&gt; foreign key table schema (may be null) + being exported (may be null) + </li> + <li> + <b>FKTABLE_NAME</b> string =&gt; foreign key table name + being exported + </li> + <li> + <b>FKCOLUMN_NAME</b> string =&gt; foreign key column name + being exported + </li> + <li> + <b>KEY_SEQ</b> short =&gt; sequence number within foreign key + </li> + <li> + <b>UPDATE_RULE</b> short =&gt; What happens to + foreign key when primary is updated: + <ul> + <li> NO_ACTION - do not allow update of primary + key if it has been imported + </li> + <li> CASCADE - change imported key to agree + with primary key update + </li> + <li> SET_NULL - change imported key to NULL if + its primary key has been updated + </li> + <li> SET_DEFAULT - change imported key to default values + if its primary key has been updated + </li> + <li> RESTRICT - same as importedKeyNoAction + (for ODBC 2.x compatibility) + </li> + </ul> + </li> + <li> + <b>DELETE_RULE</b> short =&gt; What happens to + the foreign key when primary is deleted. + <ul> + <li> NO_ACTION - do not allow delete of primary + key if it has been imported + </li> + <li> CASCADE - delete rows that import a deleted key + </li> + <li> SET_NULL - change imported key to NULL if + its primary key has been deleted + </li> + <li> RESTRICT - same as importedKeyNoAction + (for ODBC 2.x compatibility) + </li> + <li> SET_DEFAULT - change imported key to default if + its primary key has been deleted + </li> + </ul> + </li> + <li> + <b>FK_NAME</b> string =&gt; foreign key name (may be null) + </li> + <li> + <b>PK_NAME</b> string =&gt; primary key name (may be null) + </li> + <li> + <b>DEFERRABILITY</b> short =&gt; can the evaluation of foreign key + constraints be deferred until commit + <ul> + <li> INITIALLY_DEFERRED - see SQL92 for definition + </li> + <li> INITIALLY_IMMEDIATE - see SQL92 for definition + </li> + <li> NONE - see SQL92 for definition + </li> + </ul> + </li> + </ol> + */ + XResultSet getCrossReference( + [in]any primaryCatalog, [in]string primarySchema, + [in]string primaryTable, + [in]any foreignCatalog, [in]string foreignSchema, + [in]string foreignTable) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getTypeInfo + /** gets a description of all the standard SQL types supported by + this database. They are ordered by DATA_TYPE and then by how + closely the data type maps to the corresponding SDBC SQL type. + + + + <p>Each type description has the following columns: + </p> + <ol> + <li> + <b>TYPE_NAME</b> string =&gt; Type name + </li> + <li> + <b>DATA_TYPE</b> short =&gt; SQL data type from java.sql.Types + </li> + <li> + <b>PRECISION</b> long =&gt; maximum precision + </li> + <li> + <b>LITERAL_PREFIX</b> string =&gt; prefix used to quote a literal + (may be null) + </li> + <li> + <b>LITERAL_SUFFIX</b> string =&gt; suffix used to quote a literal + (may be null) + </li> + <li> + <b>CREATE_PARAMS</b> string =&gt; parameters used in creating + the type (may be null) + </li> + <li> + <b>NULLABLE</b> short =&gt; can you use NULL for this type? + <ul> + <li> NO_NULLS - does not allow NULL values + </li> + <li> NULLABLE - allows NULL values + </li> + <li> NULLABLE_UNKNOWN - nullability unknown + </li> + </ul> + </li> + <li> + <b>CASE_SENSITIVE</b> boolean=&gt; is it case sensitive? + </li> + <li> + <b>SEARCHABLE</b> short =&gt; can you use "WHERE" based on this type: + <ul> + <li> NONE - No support + </li> + <li> CHAR - Only supported with WHERE .. LIKE + </li> + <li> BASIC - Supported except for WHERE .. LIKE + </li> + <li> FULL - Supported for all WHERE .. + </li> + </ul> + </li> + <li> + <b>UNSIGNED_ATTRIBUTE</b> [const] boolean =&gt; is it unsigned? + </li> + <li> + <b>FIXED_PREC_SCALE</b> [const] boolean =&gt; can it be a money value? + </li> + <li> + <b>AUTO_INCREMENT</b> [const] boolean =&gt; can it be used for an + auto-increment value? + </li> + <li> + <b>LOCAL_TYPE_NAME</b> string =&gt; localized version of type name + (may be null) + </li> + <li> + <b>MINIMUM_SCALE</b> short =&gt; minimum scale supported + </li> + <li> + <b>MAXIMUM_SCALE</b> short =&gt; maximum scale supported + </li> + <li> + <b>SQL_DATA_TYPE</b> long =&gt; unused + </li> + <li> + <b>SQL_DATETIME_SUB</b> long =&gt; unused + </li> + <li> + <b>NUM_PREC_RADIX</b> long =&gt; usually 2 or 10 + </li> + </ol> + */ + XResultSet getTypeInfo() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getIndexInfo + /** gets a description of a table's indices and statistics. They are + ordered by NON_UNIQUE, TYPE, INDEX_NAME, and ORDINAL_POSITION. + + + <p>Each index column description has the following columns: + </p> + <ol> + <li> + <b>TABLE_CAT</b> string =&gt; table catalog (may be null) + </li> + <li> + <b>TABLE_SCHEM</b> string =&gt; table schema (may be null) + </li> + <li> + <b>TABLE_NAME</b> string =&gt; table name + </li> + <li> + <b>NON_UNIQUE</b> [const] boolean =&gt; Can index values be non-unique? + false when TYPE is tableIndexStatistic + </li> + <li> + <b>INDEX_QUALIFIER</b> string =&gt; index catalog (may be null); + null when TYPE is tableIndexStatistic + </li> + <li> + <b>INDEX_NAME</b> string =&gt; index name; null when TYPE is + tableIndexStatistic + </li> + <li> + <b>TYPE</b> short =&gt; index type: + <ul> + <li> 0 - this identifies table statistics that are + returned in conjuction with a table's index descriptions + </li> + <li> CLUSTERED - this is a clustered index + </li> + <li> HASHED - this is a hashed index + </li> + <li> OTHER - this is some other style of index + </li> + </ul> + </li> + <li> + <b>ORDINAL_POSITION</b> short =&gt; column sequence number + within index; zero when TYPE is tableIndexStatistic + </li> + <li> + <b>COLUMN_NAME</b> string =&gt; column name; null when TYPE is + tableIndexStatistic + </li> + <li> + <b>ASC_OR_DESC</b> string =&gt; column sort sequence, "A" =&gt; ascending, + "D" =&gt; descending, may be null if sort sequence is not supported; + null when TYPE is tableIndexStatistic + </li> + <li> + <b>CARDINALITY</b> long =&gt; When TYPE is tableIndexStatistic, then + this is the number of rows in the table; otherwise, it is the + number of unique values in the index. + </li> + <li> + <b>PAGES</b> long =&gt; When TYPE is tableIndexStatisic then + this is the number of pages used for the table, otherwise it + is the number of pages used for the current index. + </li> + <li> + <b>FILTER_CONDITION</b> string =&gt; Filter condition, if any. + (may be null) + </li> + </ol> + */ + XResultSet getIndexInfo([in]any catalog, [in]string schema, [in]string table, + [in]boolean unique, [in]boolean approximate) + raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsResultSetType + /** Does the database support the given result set type? + */ + [const] boolean supportsResultSetType([in]long setType) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsResultSetConcurrency + /** Does the database support the concurrency type in combination + with the given result set type? + */ + [const] boolean supportsResultSetConcurrency([in]long setType, + [in]long concurrency) + raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::ownUpdatesAreVisible + /** indicates whether a result set's own updates are visible. + */ + [const] boolean ownUpdatesAreVisible([in]long setType) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::ownDeletesAreVisible + /** indicates whether a result set's own deletes are visible. + */ + [const] boolean ownDeletesAreVisible([in]long setType) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::ownInsertsAreVisible + /** indicates whether a result set's own inserts are visible. + */ + [const] boolean ownInsertsAreVisible([in]long setType) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::othersUpdatesAreVisible + /** indicates whether updates made by others are visible. + */ + [const] boolean othersUpdatesAreVisible([in]long setType) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::othersDeletesAreVisible + /** indicates whether deletes made by others are visible. + */ + [const] boolean othersDeletesAreVisible([in]long setType) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::othersInsertsAreVisible + /** indicates whether inserts made by others are visible. + */ + [const] boolean othersInsertsAreVisible([in]long setType) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::updatesAreDetected + /** indicates whether or not a visible row update can be detected by + calling the method <code>XResultSet.rowUpdated</code>. + */ + [const] boolean updatesAreDetected([in]long setType) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::deletesAreDetected + /** indicates whether or not a visible row delete can be detected by + calling XResultSet.rowDeleted(). If deletesAreDetected() + returns <false></false>, then deleted rows are removed from the result set. + */ + [const] boolean deletesAreDetected([in]long setType) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::insertsAreDetected + /** indicates whether or not a visible row insert can be detected + by calling XResultSet.rowInserted(). + */ + [const] boolean insertsAreDetected([in]long setType) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsBatchUpdates + /** indicates whether the driver supports batch updates. + */ + [const] boolean supportsBatchUpdates() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getUDTs + /** Gets a description of the user-defined types defined in a particular + schema. Schema-specific UDTs may have type OBJECT, STRUCT, + or DISTINCT. + + + <p>Only types matching the catalog, schema, type name and type + criteria are returned. They are ordered by DATA_TYPE, TYPE_SCHEM + and TYPE_NAME. The type name parameter may be a fully-qualified + name. In this case, the catalog and schemaPattern parameters are + ignored. + </p> + <p>Each type description has the following columns: + </p> + <ol> + <li> + <b>TYPE_CAT</b> string =&gt; the type's catalog (may be null) + </li> + <li> + <b>TYPE_SCHEM</b> string =&gt; type's schema (may be null) + </li> + <li> + <b>TYPE_NAME</b> string =&gt; type name + </li> + <li> + <b>CLASS_NAME</b> string =&gt; Java class name or service name + </li> + <li> + <b>DATA_TYPE</b> string =&gt; type value. + One of OBJECT, STRUCT, or DISTINCT + </li> + <li> + <b>REMARKS</b> string =&gt; explanatory comment on the type + </li> + </ol> + <p> + <b>Note:</b> If the driver does not support UDTs, an empty + result set is returned. + </p> + */ + XResultSet getUDTs([in]any catalog, [in]string schemaPattern, + [in]string typeNamePattern, [in]sequence<long> types) + raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getConnection + /** retrieves the connection that produced this metadata object. + */ + [const] XConnection getConnection() raises (SQLException); +}; + +//============================================================================= + +}; }; }; }; + +/*=========================================================================== + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:42 hjs + initial import + + Revision 1.8 2000/09/11 11:52:43 mi + documentation merged from XML + + Revision 1.6 2000/04/27 12:01:58 dg + #75348# wrong method names corrected + + Revision 1.5 2000/03/30 12:42:18 dg + #74028# missing documentation completed + + Revision 1.4 2000/02/21 16:18:06 mi + string documentation from stardiv...*.idl-files + + Revision 1.3 2000/02/07 11:24:52 mi + zu #70728# missing documentation marked + + Revision 1.2 1999/11/26 16:52:45 dg + change documentation + + Revision 1.1 1999/11/24 08:41:05 dg + new StarDataBaseConnectivity + +===========================================================================*/ +#endif diff --git a/offapi/com/sun/star/sdbc/XDriver.idl b/offapi/com/sun/star/sdbc/XDriver.idl new file mode 100644 index 000000000000..f7af59bfa89c --- /dev/null +++ b/offapi/com/sun/star/sdbc/XDriver.idl @@ -0,0 +1,202 @@ +/************************************************************************* + * + * $RCSfile: XDriver.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:57 $ + * + * 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_sdbc_XDriver_idl__ +#define __com_sun_star_sdbc_XDriver_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_beans_PropertyValue_idl__ +#include <com/sun/star/beans/PropertyValue.idl> +#endif + +#ifndef __com_sun_star_sdbc_SQLException_idl__ +#include <com/sun/star/sdbc/SQLException.idl> +#endif + +#ifndef __com_sun_star_sdbc_DriverPropertyInfo_idl__ +#include <com/sun/star/sdbc/DriverPropertyInfo.idl> +#endif + + module com { module sun { module star { module sdbc { + +interface XConnection; +interface XDriverManager; + + +// DocMerge from xml: interface com::sun::star::sdbc::XDriver +/** is the interface that every driver class must implement. + + + + <p>Each driver should supply a service that implements + the Driver interface. + + </p> + <p>The DriverManager will try to load as many drivers as it can + find and then for any given connection request, it will ask each + driver in turn to try to connect to the target URL. + + </p> + <p>It is strongly recommended that each Driver object should be + small and standalone so that the Driver object can be loaded and + queried without bringing in vast quantities of supporting code. + + </p>@see com::sun::star::sdbc::XDriverManager + @see com::sun::star::sdbc::XConnection + */ +[ uik(D6B60233-9067-11d3-9EE00010-5AD7A5C4), ident("XDriver", 1.0) ] +interface XDriver: com::sun::star::uno::XInterface +{ + + // DocMerge from xml: method com::sun::star::sdbc::XDriver::connect + /** attempts to make a database connection to the given URL. + The driver should return <null></null> if it realizes it is the wrong kind + of driver to connect to the given URL. This will be common, as when + the driver manager is asked to connect to a given URL it passes + the URL to each loaded driver in turn. + + + + <p>The driver should raise a SQLException if it is the right + driver to connect to the given URL, but has trouble connecting to + the database. + + </p> + <p>The info argument can be used to pass arbitrary + string tag/value pairs as connection arguments. + Normally at least "user" and "password" properties should be + included in the Properties. + </p> + */ + XConnection connect( + [in]string url, + [in]sequence<com::sun::star::beans::PropertyValue> info) + raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDriver::acceptsURL + /** returns <true></true> if the driver thinks that it can open a connection + to the given URL. Typically drivers will return <true></true> if they + understand the subprotocol specified in the URL and <false></false> if + they do not. + */ + boolean acceptsURL([in]string url) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from idl: method com::sun::star::sdbc::XDriver::getPropertyInfo + /** gets information about the possible properties for this driver. + <p>The getPropertyInfo method is intended to allow a generic GUI tool to + discover what properties it should prompt a human for in order to get + enough information to connect to a database. Note that depending on + the values the human has supplied so far, additional values may become + necessary, so it may be necessary to iterate though several calls + to getPropertyInfo. + @param url + is the URL of the database to which to connect. + @param info + is a proposed list of tag/value pairs that will be sent on + connect open. + @returns + an array of DriverPropertyInfo objects describing possible + properties. This array may be an empty array if no properties + are required. + @throws SQLException + if a database access error occurs. + */ + sequence<DriverPropertyInfo> getPropertyInfo([in]string url, + [in] sequence<com::sun::star::beans::PropertyValue> info) + raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDriver::getMajorVersion + /** gets the driver's major version number. Initially this should be 1. + */ + [const] long getMajorVersion(); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDriver::getMinorVersion + /** gets the driver's minor version number. Initially this should be 0. + */ + [const] long getMinorVersion(); +}; + +//============================================================================= + +}; }; }; }; + +/*=========================================================================== + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:41 hjs + initial import + + Revision 1.4 2000/09/11 11:52:43 mi + documentation merged from XML + + Revision 1.2 1999/12/13 13:47:55 dg + #70278# XSQLErrorBroadcaster removed + + Revision 1.1 1999/11/24 08:41:05 dg + new StarDataBaseConnectivity + +===========================================================================*/ +#endif diff --git a/offapi/com/sun/star/sdbc/XDriverAccess.idl b/offapi/com/sun/star/sdbc/XDriverAccess.idl new file mode 100644 index 000000000000..db1bdb5bc5ae --- /dev/null +++ b/offapi/com/sun/star/sdbc/XDriverAccess.idl @@ -0,0 +1,105 @@ +/************************************************************************* + * + * $RCSfile: XDriverAccess.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:57 $ + * + * 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_sdbc_XDriverAccess_idl__ +#define __com_sun_star_sdbc_XDriverAccess_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + + module com { module sun { module star { module sdbc { + +interface XDriver; + + + +// DocMerge from xml: interface com::sun::star::sdbc::XDriverAccess +/** provides the access of sdbc driver components@see com::sun::star::sdbc::XDriverManager + @see com::sun::star::sdbc::XDriver + */ +[ uik(8D8D8A3A-3614-11d4-87320050-04D8BBE7), ident("XDriverAccess", 1.0) ] +interface XDriverAccess: com::sun::star::uno::XInterface +{ + + // DocMerge from xml: method com::sun::star::sdbc::XDriverAccess::getDriverByURL + /** get a driver which accepts a given url.@see XDriver::acceptsURL + */ + XDriver getDriverByURL([in]string url); +}; + +//============================================================================= + +}; }; }; }; + +/*=========================================================================== + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:42 hjs + initial import + + Revision 1.3 2000/09/11 11:52:43 mi + documentation merged from XML + + Revision 1.1 2000/06/09 14:09:42 fs + new StarDatabaseConnectivity + + +===========================================================================*/ +#endif diff --git a/offapi/com/sun/star/sdbc/XDriverManager.idl b/offapi/com/sun/star/sdbc/XDriverManager.idl new file mode 100644 index 000000000000..9619c6f1a9e5 --- /dev/null +++ b/offapi/com/sun/star/sdbc/XDriverManager.idl @@ -0,0 +1,154 @@ +/************************************************************************* + * + * $RCSfile: XDriverManager.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:57 $ + * + * 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_sdbc_XDriverManager_idl__ +#define __com_sun_star_sdbc_XDriverManager_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_beans_PropertyValue_idl__ +#include <com/sun/star/beans/PropertyValue.idl> +#endif + +#ifndef __com_sun_star_sdbc_SQLException_idl__ +#include <com/sun/star/sdbc/SQLException.idl> +#endif + + module com { module sun { module star { module sdbc { + +interface XConnection; +interface XDriver; + + +// DocMerge from xml: interface com::sun::star::sdbc::XDriverManager +/** is the basic interface for managing a set of SDBC drivers. + + + + <p>When the method <code>getConnection</code> is called, + the DriverManager will attempt to + locate a suitable driver. + + </p>@see com::sun::star::sdbc::XDriver + @see com::sun::star::sdbc::XConnection + */ +[ uik(D6B60237-9067-11d3-9EE00010-5AD7A5C4), ident("XDriverManager", 1.0) ] +interface XDriverManager: com::sun::star::uno::XInterface +{ + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDriverManager::getConnection + /** attempts to establish a connection to the given database URL. + The DriverManager attempts to select an appropriate driver from + the set of registered JDBC/SDBC drivers. + */ + XConnection getConnection([in]string url) + raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDriverManager::getConnectionWithInfo + /** attempts to establish a connection to the given database URL. + The DriverManager attempts to select an appropriate driver from + the set of registered JDBC/SDBC drivers. + */ + XConnection getConnectionWithInfo([in]string url, + [in]sequence<com::sun::star::beans::PropertyValue> info) + raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDriverManager::setLoginTimeout + /** sets the maximum time in seconds that a driver will wait + while attempting to connect to a database. + */ + void setLoginTimeout([in]long seconds); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XDriverManager::getLoginTimeout + /** gets the maximum time in seconds that a driver can wait + when attempting to login to a database. + */ + [const] long getLoginTimeout(); +}; + +//============================================================================= + +}; }; }; }; + +/*=========================================================================== + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:42 hjs + initial import + + Revision 1.5 2000/09/11 11:52:43 mi + documentation merged from XML + + Revision 1.3 1999/12/14 12:05:46 dg + #70278# CompareBookmark removed + + Revision 1.2 1999/12/13 13:47:55 dg + #70278# XSQLErrorBroadcaster removed + + Revision 1.1 1999/11/24 08:41:06 dg + new StarDataBaseConnectivity + +===========================================================================*/ +#endif diff --git a/offapi/com/sun/star/sdbc/XMultipleResults.idl b/offapi/com/sun/star/sdbc/XMultipleResults.idl new file mode 100644 index 000000000000..7554d30d12a5 --- /dev/null +++ b/offapi/com/sun/star/sdbc/XMultipleResults.idl @@ -0,0 +1,146 @@ +/************************************************************************* + * + * $RCSfile: XMultipleResults.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:57 $ + * + * 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_sdbc_XMultipleResults_idl__ +#define __com_sun_star_sdbc_XMultipleResults_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_sdbc_SQLException_idl__ +#include <com/sun/star/sdbc/SQLException.idl> +#endif + + module com { module sun { module star { module sdbc { + +interface XResultSet; + + +// DocMerge from xml: interface com::sun::star::sdbc::XMultipleResults +/** is used for inspecting multiple results produced by the execution of a + SQL statement. + + + <p>Under some (uncommon) situations a single SQL statement may return + multiple result sets and/or update counts. Normally you can ignore + this unless you are (1) executing a stored procedure that you know may + return multiple results or (2) you are dynamically executing an + unknown SQL string. The methods <code>getMoreResults</code>, + <code>getResultSet</code> and <code>getUpdateCount</code> let you navigate + through multiple results. + + </p>@see com::sun::star::sdbc::XStatement + @see com::sun::star::sdbc::XPreparedStatement + */ +[ uik(D6B60243-9067-11d3-9EE00010-5AD7A5C4), ident("XMultipleResults", 1.0) ] +interface XMultipleResults: com::sun::star::uno::XInterface +{ + + // DocMerge from xml: method com::sun::star::sdbc::XMultipleResults::getResultSet + /** returns the current result as a <code>ResultSet</code> object. + This method should be called only once per result. + */ + XResultSet getResultSet() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XMultipleResults::getUpdateCount + /** returns the current result as an update count. + + + <p>if the result is a ResultSet or there are no more results, -1 + is returned. This method should be called only once per result. + </p> + */ + long getUpdateCount() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XMultipleResults::getMoreResults + /** moves to a Statement's next result. It returns <true></true> if + this result is a ResultSet. This method also implicitly + closes any current ResultSet obtained with getResultSet. + + + + <p>There are no more results when <code>(!getMoreResults() &amp;&amp; + getUpdateCount() == -1)</code>. + + </p> + */ + boolean getMoreResults() raises (SQLException); +}; + +//============================================================================= + +}; }; }; }; + +/*=========================================================================== + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:42 hjs + initial import + + Revision 1.3 2000/09/11 11:52:43 mi + documentation merged from XML + + Revision 1.1 1999/11/24 08:41:06 dg + new StarDataBaseConnectivity + +===========================================================================*/ +#endif diff --git a/offapi/com/sun/star/sdbc/XOutParameters.idl b/offapi/com/sun/star/sdbc/XOutParameters.idl new file mode 100644 index 000000000000..2034c30aea15 --- /dev/null +++ b/offapi/com/sun/star/sdbc/XOutParameters.idl @@ -0,0 +1,159 @@ +/************************************************************************* + * + * $RCSfile: XOutParameters.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:57 $ + * + * 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_sdbc_XOutParameters_idl__ +#define __com_sun_star_sdbc_XOutParameters_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_sdbc_SQLException_idl__ +#include <com/sun/star/sdbc/SQLException.idl> +#endif + + module com { module sun { module star { module sdbc { + + +// DocMerge from xml: interface com::sun::star::sdbc::XOutParameters +/** is used to register Out-Parameters for stored procedures. + + + <p>SDBC provides a stored procedure SQL escape that allows stored procedures + to be called in a standard way for all RDBMSs. This escape syntax has one + form that includes a result parameter and one that does not. If used, the + result parameter must be registered as an OUT parameter. The other parameters + can be used for input, output, or both. Parameters are referred to sequentially, + by number. The first parameter is 1.</p> + */ +[ uik(D6B60246-9067-11d3-9EE00010-5AD7A5C4), ident("XOutParameters", 1.0) ] +interface XOutParameters: com::sun::star::uno::XInterface +{ + + // DocMerge from xml: method com::sun::star::sdbc::XOutParameters::registerOutParameter + /** registers the designated output parameter. This version of + the method <code>registerOutParameter</code> + should be used for a user-named or REF output parameter. Examples + of user-named types include: STRUCT, DISTINCT, OBJECT, and named array + types. + + + <p>Before executing a stored procedure call, you must explicitly + call <code>registerOutParameter</code> to register the type from + <code>DataType</code> for each OUT parameter. + <br>For a user-named parameter the fully-qualified SQL type name of the + parameter should also be given, while a REF parameter requires that the + fully-qualified type name of the referenced type be given. + An SDBC driver that does not need the type code and type name information + may ignore it. To be portable, however, applications should always provide + these values for user-named and REF parameters. + </p> + <p>Although it is intended for user-named and REF parameters, + this method may be used to register a parameter of any SDBC type. + If the parameter does not have a user-named or REF type, the + typeName parameter is ignored. + </p> + <p> + <b>Note:</b> When reading the value of an out parameter, you + must use the <code>getXXX</code> method whose type XXX corresponds to the + parameter's registered SQL type. + </p> + */ + void registerOutParameter([in]long parameterIndex, [in]long sqlType, + [in]string typeName) + raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XOutParameters::registerNumericOutParameter + /** registers the OUT parameter in ordinal position + <code>parameterIndex</code> to the SDBC type <code>sqlType</code>. All + OUT parameters must be registered before a stored procedure is executed. + + + <p>The SDBC type specified by <code>sqlType</code> for an OUT parameter + determines the type that must be used in the <code>get</code> method to + read the value of that parameter. + This version of <code>registerOutParameter</code> should be + used when the parameter is of SDBC type <code>NUMERIC</code> + or <code>DECIMAL</code>. + </p> + */ + void registerNumericOutParameter([in]long parameterIndex, [in]long sqlType, + [in]long scale) + raises (SQLException); +}; + +//============================================================================= + +}; }; }; }; + +/*=========================================================================== + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:42 hjs + initial import + + Revision 1.3 2000/09/11 11:52:43 mi + documentation merged from XML + + Revision 1.1 1999/11/24 08:41:06 dg + new StarDataBaseConnectivity + +===========================================================================*/ +#endif diff --git a/offapi/com/sun/star/sdbc/XParameters.idl b/offapi/com/sun/star/sdbc/XParameters.idl new file mode 100644 index 000000000000..bc3bd9d13b2e --- /dev/null +++ b/offapi/com/sun/star/sdbc/XParameters.idl @@ -0,0 +1,395 @@ +/************************************************************************* + * + * $RCSfile: XParameters.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:57 $ + * + * 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_sdbc_XParameters_idl__ +#define __com_sun_star_sdbc_XParameters_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_util_Date_idl__ +#include <com/sun/star/util/Date.idl> +#endif + +#ifndef __com_sun_star_util_DateTime_idl__ +#include <com/sun/star/util/DateTime.idl> +#endif + +#ifndef __com_sun_star_util_Time_idl__ +#include <com/sun/star/util/Time.idl> +#endif + + module com { module sun { module star { module io { +interface XInputStream; +};};};}; + +#ifndef __com_sun_star_sdbc_SQLException_idl__ +#include <com/sun/star/sdbc/SQLException.idl> +#endif + + module com { module sun { module star { module sdbc { + +interface XRef; +interface XArray; +interface XBlob; +interface XClob; + + +// DocMerge from xml: interface com::sun::star::io::com::sun::star::sdbc::XParameters +/** is used for parameter setting, commently implemented in conjunction with + PreparedStatements. + + + <p> + <b>Note:</b> The setXXX methods for setting IN parameter values + must specify types that are compatible with the defined SQL type of + the input parameter. For instance, if the IN parameter has SQL type + Integer, then the method <code>setLong</code> should be used. + + </p> + <p>If arbitrary parameter type conversions are required, the method + <code>setObject</code> should be used with a target SQL type. + <br> + <br> + Example of setting a parameter; <code>con</code> is an active connection. + </p> + + + + + + @example <listing>pstmt = con.prepareStatement("UPDATE EMPLOYEES SET SALARY = ? WHERE ID = ?") + pstmt.setDouble(1, 153833.00) + pstmt.setLong(2, 110592) + </listing>@see com::sun::star::sdbc::XPreparedStatement + */ +[ uik(5FFEC2E2-9520-11d3-8168D521-22976675), ident("XParameters", 1.0) ] +interface XParameters: com::sun::star::uno::XInterface +{ + + // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XParameters::setNull + /** sets the designated parameter to SQL NULL. + */ + void setNull([in]long parameterIndex, + [in]long sqlType) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XParameters::setObjectNull + /** sets the designated parameter to SQL NULL. This version of setNull should + be used for user-named types and REF type parameters. Examples + of user-named types include: STRUCT, DISTINCT, OBJECT, and + named array types. + + + <p> + <b>Note:</b> To be portable, applications must give the + SQL type code and the fully-qualified SQL type name when specifying + a NULL user-defined or REF parameter. In the case of a user-named type + the name is the type name of the parameter itself. For a REF + parameter the name is the type name of the referenced type. If + a SDBC driver does not need the type code or type name information, + it may ignore it.<br> + Although it is intended for user-named and Ref parameters, + this method may be used to set a null parameter of any JDBC type. + If the parameter does not have a user-named or REF type, the given + typeName is ignored. + </p> + */ + void setObjectNull([in]long parameterIndex, + [in]long sqlType, + [in]string typeName) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XParameters::setBoolean + /** sets the designated parameter to a boolean value. The driver converts this + to a SQL BIT value when it sends it to the database. + */ + void setBoolean([in]long parameterIndex, [in]boolean x) + raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XParameters::setByte + /** sets the designated parameter to a byte value. The driver converts this + to a SQL TINYINT value when it sends it to the database. + */ + void setByte([in]long parameterIndex, [in]byte x) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XParameters::setShort + /** sets the designated parameter to a short value. The driver converts this + to a SQL SMALLINT value when it sends it to the database. + */ + void setShort([in]long parameterIndex, [in]short x) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XParameters::setInt + /** sets the designated parameter to a long value. The driver converts this + to a SQL INTEGER value when it sends it to the database. + */ + void setInt([in]long parameterIndex, [in]long x) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XParameters::setLong + /** sets the designated parameter to a hyper value. The driver converts this + to a SQL BIGINT value when it sends it to the database. + */ + void setLong([in]long parameterIndex, [in]hyper x) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XParameters::setFloat + /** sets the designated parameter to a float value. The driver converts this + to a SQL FLOAT value when it sends it to the database. + */ + void setFloat([in]long parameterIndex, [in]float x) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XParameters::setDouble + /** sets the designated parameter to a double value. The driver converts this + to a SQL DOUBLE value when it sends it to the database. + */ + void setDouble([in]long parameterIndex, [in]double x) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XParameters::setString + /** sets the designated parameter to a string value. The driver converts this + to a SQL VARCHAR or LONGVARCHAR value (depending on the argument's + size relative to the driver's limits on VARCHARs) when it sends + it to the database. + */ + void setString([in]long parameterIndex, [in]string x) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XParameters::setBytes + /** sets the designated parameter to a sequence of bytes. The driver converts + this to a SQL VARBINARY or LONGVARBINARY (depending on the + argument's size relative to the driver's limits on VARBINARYs) + when it sends it to the database. + */ + void setBytes([in]long parameterIndex, [in]sequence<byte> x) + raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XParameters::setDate + /** sets the designated parameter to a date value. The driver converts this + to a SQL DATE value when it sends it to the database. + */ + void setDate([in]long parameterIndex, [in]com::sun::star::util::Date x) + raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XParameters::setTime + /** sets the designated parameter to a time value. The driver converts this + to a SQL TIME value when it sends it to the database. + */ + void setTime([in]long parameterIndex, [in]com::sun::star::util::Time x) + raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XParameters::setTimestamp + /** sets the designated parameter to a datetime value. The driver + converts this to a SQL TIMESTAMP value when it sends it to the + database. + */ + void setTimestamp([in]long parameterIndex, + [in]com::sun::star::util::DateTime x) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XParameters::setBinaryStream + /** sets the designated parameter to the given input stream, which will have + the specified number of bytes. + When a very large binary value is input to a LONGVARBINARY or LONGVARCHAR + parameter, it may be more practical to send it via an + <type scope="com::sun::star::io">XInputStream</type>. SDBC will read the data + from the stream as needed, until it reaches end-of-file. + */ + void setBinaryStream([in]long parameterIndex, + [in]com::sun::star::io::XInputStream x, + [in]long length) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XParameters::setCharacterStream + /** sets the designated parameter to the given input stream, which will have + the specified number of bytes. + When a very large binary value is input to a LONGVARCHAR + parameter, it may be more practical to send it via a + <type scope="com::sun::star::io">XInputStream</type>. SDBC will read the data + from the stream as needed, until it reaches end-of-file. + */ + void setCharacterStream([in]long parameterIndex, + [in]com::sun::star::io::XInputStream x, + [in]long length) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XParameters::setObject + /** sets the value of a parameter using an any. + + + <p>The given object will be converted to the targetSqlType + before being sent to the database. + If the object has a custom mapping (is of a class implementing SQLData), + the SDBC driver should call its method <code>writeSQL</code> to write it + to the SQL data stream. + If, on the other hand, the object is of a service implementing Ref, Blob, + Clob, Struct, or Array, the driver should pass it to the database as a + value of the corresponding SQL type. + </p> + <p>Note that this method may be used to pass database-specific + abstract data types. + </p> + */ + void setObject([in]long parameterIndex, [in]any x) + raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XParameters::setObjectWithInfo + /** set a value from the Datatype ANY for a parameter. + + + + <p>The given object will be converted to the targetSqlType + before being sent to the database. + If the object has a custom mapping (is of a class implementing SQLData), + the SDBC driver should call its method <code>writeSQL</code> to write it + to the SQL data stream. + If, on the other hand, the object is of a service implementing Ref, Blob, + Clob, Struct, or Array, the driver should pass it to the database as a + value of the corresponding SQL type. + </p> + <p>Note that this method may be used to pass database-specific + abstract data types. + </p> + */ + void setObjectWithInfo([in]long parameterIndex, + [in]any x, [in]long targetSqlType, [in]long scale) + raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XParameters::setRef + /** sets a REF(&lt;structured-type&gt;) parameter. + */ + void setRef ([in]long parameterIndex, [in]XRef x) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XParameters::setBlob + /** sets a BLOB parameter. + */ + void setBlob ([in]long parameterIndex, [in]XBlob x) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XParameters::setClob + /** sets a CLOB parameter. + */ + void setClob ([in]long parameterIndex, [in]XClob x) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XParameters::setArray + /** sets an Array parameter. + */ + void setArray ([in]long parameterIndex, [in]XArray x) raises (SQLException); + + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XParameters::clearParameters + /** clears the current parameter values immediately. + + + <p>In general, parameter values remain in force for repeated use of a + Statement. Setting a parameter value automatically clears its + previous value. However, in some cases it is useful to immediately + release the resources used by the current parameter values; this can + be done by calling clearParameters. + </p> + */ + void clearParameters() raises (SQLException); +}; + +//============================================================================= + +}; }; }; }; + +/*=========================================================================== + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:42 hjs + initial import + + Revision 1.8 2000/09/11 11:52:43 mi + documentation merged from XML + + Revision 1.6 2000/01/28 07:57:16 dg + #72121# documentation of update/setCharacterStream + + Revision 1.5 1999/12/20 16:11:35 dg + #70278# changes in API + + Revision 1.4 1999/12/13 13:47:55 dg + #70278# XSQLErrorBroadcaster removed + + Revision 1.3 1999/12/06 07:57:52 dg + #70278# method renamed + + Revision 1.2 1999/11/24 11:33:26 dg + chk includes + + Revision 1.1 1999/11/24 08:41:06 dg + new StarDataBaseConnectivity + +===========================================================================*/ +#endif diff --git a/offapi/com/sun/star/sdbc/XPreparedBatchExecution.idl b/offapi/com/sun/star/sdbc/XPreparedBatchExecution.idl new file mode 100644 index 000000000000..d42f9c836127 --- /dev/null +++ b/offapi/com/sun/star/sdbc/XPreparedBatchExecution.idl @@ -0,0 +1,130 @@ +/************************************************************************* + * + * $RCSfile: XPreparedBatchExecution.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:57 $ + * + * 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_sdbc_XPreparedBatchExecution_idl__ +#define __com_sun_star_sdbc_XPreparedBatchExecution_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_sdbc_SQLException_idl__ +#include <com/sun/star/sdbc/SQLException.idl> +#endif + + module com { module sun { module star { module sdbc { + + +// DocMerge from xml: interface com::sun::star::sdbc::XPreparedBatchExecution +/** is used for batch execution on PreparedStatements. + + + <p>A PreparedStatement uses one precompiled SQL Statement. In batch execution + it is possible to set collection of parameter settings, which are executed in + one batch job.</p> + */ +[ uik(73DE5BB7-D7BF-11d3-9FC00010-5AEF84A7), ident("XPreparedBatchExecution", 1.0) ] +interface XPreparedBatchExecution: com::sun::star::uno::XInterface +{ + + // DocMerge from xml: method com::sun::star::sdbc::XPreparedBatchExecution::addBatch + /** adds a set of parameters to the batch. + */ + void addBatch() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XPreparedBatchExecution::clearBatch + /** makes the set of commands in the current batch empty. + */ + void clearBatch() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from idl: method com::sun::star::sdbc::XPreparedBatchExecution::executeBatch + /** submits a batch of commands to the database for execution. + @returns + an array of update counts containing one element for each + command in the batch. The array is ordered according to the order in + which commands were inserted into the batch. + @throws SQLException + if a database access error occurs. + */ + sequence<long> executeBatch() raises (SQLException); +}; + +//============================================================================= + +}; }; }; }; + +/*=========================================================================== + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:38 hjs + initial import + + Revision 1.4 2000/09/11 11:52:43 mi + documentation merged from XML + + Revision 1.2 2000/01/31 10:44:09 mi + #72484# UIKs were not unique + + Revision 1.1 1999/11/24 08:41:07 dg + new StarDataBaseConnectivity + +===========================================================================*/ +#endif diff --git a/offapi/com/sun/star/sdbc/XPreparedStatement.idl b/offapi/com/sun/star/sdbc/XPreparedStatement.idl new file mode 100644 index 000000000000..32ac2480374b --- /dev/null +++ b/offapi/com/sun/star/sdbc/XPreparedStatement.idl @@ -0,0 +1,147 @@ +/************************************************************************* + * + * $RCSfile: XPreparedStatement.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:57 $ + * + * 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_sdbc_XPreparedStatement_idl__ +#define __com_sun_star_sdbc_XPreparedStatement_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_sdbc_SQLException_idl__ +#include <com/sun/star/sdbc/SQLException.idl> +#endif + + module com { module sun { module star { module sdbc { + +interface XConnection; +interface XResultSet; + + +// DocMerge from xml: interface com::sun::star::sdbc::XPreparedStatement +/** provides the possibilty of executing a precompiled SQL statement. + + + <p>A SQL statement is pre-compiled and stored in a PreparedStatement object. + This object can then be used to efficiently execute this statement multiple + times.</p> + */ +[ uik(D6B60245-9067-11d3-9EE00010-5AD7A5C4), ident("XPreparedStatement", 1.0) ] +interface XPreparedStatement: com::sun::star::uno::XInterface +{ + + // DocMerge from xml: method com::sun::star::sdbc::XPreparedStatement::executeQuery + /** executes the SQL query in this <code>PreparedStatement</code> object + and returns the result set generated by the query. + */ + XResultSet executeQuery() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XPreparedStatement::executeUpdate + /** executes the SQL INSERT, UPDATE or DELETE statement in this + <code>PreparedStatement</code> object.<br> + In addition, SQL statements that return nothing, such as + SQL DDL statements, can be executed. + */ + long executeUpdate() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XPreparedStatement::execute + /** executes any kind of SQL statement. + + + <p>Some prepared statements return multiple results; the execute + method handles these complex statements as well as the simpler + form of statements handled by executeQuery and executeUpdate. + </p> + */ + boolean execute() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XPreparedStatement::getConnection + /** returns the <code>Connection</code> object + that produced this <code>Statement</code> object. + */ + [const] XConnection getConnection() raises (SQLException); +}; + +//============================================================================= + +}; }; }; }; + +/*=========================================================================== + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:42 hjs + initial import + + Revision 1.5 2000/09/11 11:52:43 mi + documentation merged from XML + + Revision 1.3 2000/03/30 12:20:39 dg + #74028# missing documentation completed + + Revision 1.2 2000/02/07 11:24:52 mi + zu #70728# missing documentation marked + + Revision 1.1 1999/11/24 08:41:07 dg + new StarDataBaseConnectivity + +===========================================================================*/ +#endif diff --git a/offapi/com/sun/star/sdbc/XRef.idl b/offapi/com/sun/star/sdbc/XRef.idl new file mode 100644 index 000000000000..df2ed8efd8ce --- /dev/null +++ b/offapi/com/sun/star/sdbc/XRef.idl @@ -0,0 +1,108 @@ +/************************************************************************* + * + * $RCSfile: XRef.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:57 $ + * + * 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_sdbc_XRef_idl__ +#define __com_sun_star_sdbc_XRef_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_sdbc_SQLException_idl__ +#include <com/sun/star/sdbc/SQLException.idl> +#endif + + module com { module sun { module star { module sdbc { + + +// DocMerge from xml: interface com::sun::star::sdbc::XRef +/** is the reference to a SQL structured type value in the database. A + Ref can be saved to persistent storage. A Ref is dereferenced by + passing it as a parameter to a SQL statement and executing the + statement. + */ +[ uik(D6B6023C-9067-11d3-9EE00010-5AD7A5C4), ident("XRef", 1.0) ] +interface XRef: com::sun::star::uno::XInterface +{ + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XRef::getBaseTypeName + /** gets the fully-qualified SQL structured type name of the referenced item. + */ + string getBaseTypeName() raises (SQLException); +}; + +//============================================================================= + +}; }; }; }; + +/*=========================================================================== + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:42 hjs + initial import + + Revision 1.3 2000/09/11 11:52:43 mi + documentation merged from XML + + Revision 1.1 1999/11/24 08:41:07 dg + new StarDataBaseConnectivity + +===========================================================================*/ +#endif diff --git a/offapi/com/sun/star/sdbc/XResultSet.idl b/offapi/com/sun/star/sdbc/XResultSet.idl new file mode 100644 index 000000000000..391bd6d17a9f --- /dev/null +++ b/offapi/com/sun/star/sdbc/XResultSet.idl @@ -0,0 +1,316 @@ +/************************************************************************* + * + * $RCSfile: XResultSet.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:57 $ + * + * 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_sdbc_XResultSet_idl__ +#define __com_sun_star_sdbc_XResultSet_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_sdbc_SQLException_idl__ +#include <com/sun/star/sdbc/SQLException.idl> +#endif + + module com { module sun { module star { module sdbc { + +interface XStatement; + + +// DocMerge from xml: interface com::sun::star::sdbc::XResultSet +/** provides the navigation on a table of data. A ResultSet + object is usually generated by executing a Statement. + + + <p>A ResultSet maintains a cursor pointing to its current row of + data. Initially the cursor is positioned before the first row. + The 'next' method moves the cursor to the next row.</p> + */ +[ uik(D6B60249-9067-11d3-9EE00010-5AD7A5C4), ident("XResultSet", 1.0) ] +interface XResultSet: com::sun::star::uno::XInterface +{ + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XResultSet::next + /** moves the cursor down one row from its current position. + + + <p>A ResultSet cursor is initially positioned before the first row; the + first call to next makes the first row the current row; the + second call makes the second row the current row, and so on. + </p> + <p>If an input stream is open for the current row, a call + to the method <code>moveNext</code> will implicitly close it. + The ResultSet's warning chain is cleared when a new row is read. + </p> + */ + boolean next() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XResultSet::isBeforeFirst + /** indicates whether the cursor is before the first row in the result + set. + */ + boolean isBeforeFirst() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XResultSet::isAfterLast + /** indicates whether the cursor is after the last row in the result + set. + */ + boolean isAfterLast() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XResultSet::isFirst + /** indicates whether the cursor is on the first row of the result set. + */ + boolean isFirst() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XResultSet::isLast + /** indicates whether the cursor is on the last row of the result set. + + + <p>Note: Calling the method <code>isAtLast</code> may be expensive + because the SDBC driver might need to fetch ahead one row in order + to determine whether the current row is the last row in the result set. + </p> + */ + boolean isLast() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XResultSet::beforeFirst + /** moves the cursor to the front of the result set, just before the + first row. Has no effect if the result set contains no rows. + */ + void beforeFirst() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XResultSet::afterLast + /** moves the cursor to the end of the result set, just after the last + row. Has no effect if the result set contains no rows. + */ + void afterLast() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XResultSet::first + /** moves the cursor to the first row in the result set. + */ + boolean first() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XResultSet::last + /** moves the cursor to the last row in the result set. + */ + boolean last() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XResultSet::getRow + /** retrieves the current row number. The first row is number 1, the + second number 2, and so on. + */ + long getRow() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XResultSet::absolute + /** moves the cursor to the given row number in the result set. + + + <p>If the row number is positive, the cursor moves to + the given row number with respect to the + beginning of the result set. The first row is row 1, the second + is row 2, and so on. + </p> + <p>If the given row number is negative, the cursor moves to + an absolute row position with respect to + the end of the result set. For example, calling + <code>moveToPosition(-1)</code> positions the + cursor on the last row, <code>moveToPosition(-2)</code> indicates the + next-to-last row, and so on. + </p> + <p>An attempt to position the cursor beyond the first/last row in + the result set leaves the cursor before/after the first/last + row, respectively. + </p> + <p>Note: Calling <code>moveToPosition(1)</code> is the same + as calling <code>moveToFirst()</code>. + Calling <code>moveToPosition(-1)</code> is the same as calling + <code>moveToLast()</code>. + </p> + */ + boolean absolute([in] long row ) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XResultSet::relative + /** moves the cursor a relative number of rows, either positive or negative. + + + <p> + Attempting to move beyond the first/last row in the result set + positions the cursor before/after + the first/last row. Calling <code>moveRelative(0)</code> is valid, but does + not change the cursor position. + + </p> + <p>Note: Calling <code>moveRelative(1)</code> + is different from calling <code>moveNext()</code> + because is makes sense to call <code>moveNext()</code> when there is + no current row, for example, when the cursor is positioned before + the first row or after the last row of the result set. + </p> + */ + boolean relative([in]long rows) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XResultSet::previous + /** moves the cursor to the previous row in the result set. + + + <p>Note: <code>previous()</code> is not the same as + <code>relative(-1)</code> because it + makes sense to call <code>previous()</code> when there is no current row. + </p> + */ + boolean previous() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XResultSet::refreshRow + /** refreshes the current row with its most recent value in + the database. Cannot be called when on the insert row. + The <code>refreshRow</code> method provides a way for an application to + explicitly tell the SDBC driver to refetch a row(s) from the + database. An application may want to call <code>refreshRow</code> when + caching or prefetching is being done by the SDBC driver to + fetch the latest value of a row from the database. The SDBC driver + may actually refresh multiple rows at once if the fetch size is + greater than one. + All values are refetched subject to the transaction isolation + level and cursor sensitivity. If <code>refreshRow</code> is called after + calling <code>updateXXX</code>, but before calling <code>updateRow</code>, + then the updates made to the row are lost. + Calling the method <code>refreshRow</code> frequently will likely + slow performance. + */ + void refreshRow() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XResultSet::rowUpdated + /** indicates whether the current row has been updated. The value returned + depends on whether or not the result set can detect updates. + */ + boolean rowUpdated() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XResultSet::rowInserted + /** indicates whether the current row has had an insertion. The value returned + depends on whether or not the result set can detect visible inserts. + */ + boolean rowInserted() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XResultSet::rowDeleted + /** indicates whether a row has been deleted. A deleted row may leave + a visible "hole" in a result set. This method can be used to + detect holes in a result set. The value returned depends on whether + or not the result set can detect deletions. + */ + boolean rowDeleted() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XResultSet::getStatement + /** returns the Statement that produced this <code>ResultSet</code> object. + If the result set was generated some other way, such as by an + <code>XDatabaseMetaData</code> method, this method returns <null></null>. + */ + [const]com::sun::star::uno::XInterface getStatement() raises (SQLException); +}; + +//============================================================================= + +}; }; }; }; + +/*=========================================================================== + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:42 hjs + initial import + + Revision 1.8 2000/09/11 11:52:43 mi + documentation merged from XML + + Revision 1.6 2000/03/30 12:20:39 dg + #74028# missing documentation completed + + Revision 1.5 2000/03/16 11:29:22 mi + UCB complient documentation (optional) + + Revision 1.4 2000/02/07 11:24:53 mi + zu #70728# missing documentation marked + + Revision 1.3 2000/01/06 07:27:42 dg + #70278# rowDeleted moved to XResultSet + + Revision 1.2 1999/12/13 13:47:55 dg + #70278# XSQLErrorBroadcaster removed + + Revision 1.1 1999/11/24 08:41:08 dg + new StarDataBaseConnectivity + +===========================================================================*/ +#endif diff --git a/offapi/com/sun/star/sdbc/XResultSetMetaData.idl b/offapi/com/sun/star/sdbc/XResultSetMetaData.idl new file mode 100644 index 000000000000..fdc430429597 --- /dev/null +++ b/offapi/com/sun/star/sdbc/XResultSetMetaData.idl @@ -0,0 +1,237 @@ +/************************************************************************* + * + * $RCSfile: XResultSetMetaData.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:57 $ + * + * 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_sdbc_XResultSetMetaData_idl__ +#define __com_sun_star_sdbc_XResultSetMetaData_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_sdbc_SQLException_idl__ +#include <com/sun/star/sdbc/SQLException.idl> +#endif + + module com { module sun { module star { module sdbc { + + +// DocMerge from xml: interface com::sun::star::sdbc::XResultSetMetaData +/** can be used to find out about the types and properties + of the columns in a ResultSet. + */ +[ uik(D6B60241-9067-11d3-9EE00010-5AD7A5C4), ident("XResultSetMetaData", 1.0) ] +interface XResultSetMetaData: com::sun::star::uno::XInterface +{ + + // DocMerge from xml: method com::sun::star::sdbc::XResultSetMetaData::getColumnCount + /** returns the number of columns in this ResultSet. + */ + long getColumnCount() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XResultSetMetaData::isAutoIncrement + /** indicates whether the column is automatically numbered, thus read-only. + */ + boolean isAutoIncrement([in]long column) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XResultSetMetaData::isCaseSensitive + /** indicates whether a column's case matters. + */ + boolean isCaseSensitive([in]long column) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XResultSetMetaData::isSearchable + /** indicates whether the column can be used in a where clause. + */ + boolean isSearchable([in]long column) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XResultSetMetaData::isCurrency + /** indicates whether the column is a cash value. + */ + boolean isCurrency([in]long column) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XResultSetMetaData::isNullable + /** indicates the nullability of values in the designated column.@see com::sun::star::sdbc::ColumnValue + */ + long isNullable([in]long column) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XResultSetMetaData::isSigned + /** indicates whether values in the column are signed numbers. + */ + boolean isSigned([in]long column) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XResultSetMetaData::getColumnDisplaySize + /** indicates the column's normal max width in chars. + */ + long getColumnDisplaySize([in]long column) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XResultSetMetaData::getColumnLabel + /** gets the suggested column title for use in printouts and + displays. + */ + string getColumnLabel([in]long column) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XResultSetMetaData::getColumnName + /** gets a column's name. + */ + string getColumnName([in]long column) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XResultSetMetaData::getSchemaName + /** gets a column's table's schema. + */ + string getSchemaName([in]long column) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XResultSetMetaData::getPrecision + /** gets a column's number of decimal digits. + */ + long getPrecision([in]long column) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XResultSetMetaData::getScale + /** gets a column's number of digits to right of the decimal point. + */ + long getScale([in]long column) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XResultSetMetaData::getTableName + /** gets a column's table name. + */ + string getTableName([in]long column) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XResultSetMetaData::getCatalogName + /** gets a column's table's catalog name. + */ + string getCatalogName([in]long column) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XResultSetMetaData::getColumnType + /** retrieves a column's SQL type. + */ + long getColumnType([in]long column) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XResultSetMetaData::getColumnTypeName + /** retrieves a column's database-specific type name. + */ + string getColumnTypeName([in]long column) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XResultSetMetaData::isReadOnly + /** indicates whether a column is definitely not writable. + */ + boolean isReadOnly([in]long column) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XResultSetMetaData::isWritable + /** indicates whether it is possible for a write on the column to succeed. + */ + boolean isWritable([in]long column) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XResultSetMetaData::isDefinitelyWritable + /** indicates whether a write on the column will definitely succeed. + */ + boolean isDefinitelyWritable([in]long column) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XResultSetMetaData::getColumnServiceName + /** returns the fully-qualified name of the service whose instances + are manufactured if the method <code>ResultSet.getObject</code> + is called to retrieve a value from the column. + */ + string getColumnServiceName([in]long column) raises (SQLException); +}; + +//============================================================================= + +}; }; }; }; + +/*=========================================================================== + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:42 hjs + initial import + + Revision 1.7 2000/09/11 11:52:43 mi + documentation merged from XML + + Revision 1.5 2000/05/09 07:53:07 dg + #75698# Method getScale(...) was not identified as method in the idl + + Revision 1.4 2000/02/07 11:24:53 mi + zu #70728# missing documentation marked + + Revision 1.3 1999/11/30 15:57:51 dg + new + + Revision 1.1 1999/11/24 08:41:08 dg + new StarDataBaseConnectivity + +===========================================================================*/ +#endif diff --git a/offapi/com/sun/star/sdbc/XResultSetMetaDataSupplier.idl b/offapi/com/sun/star/sdbc/XResultSetMetaDataSupplier.idl new file mode 100644 index 000000000000..b208fa1e9f26 --- /dev/null +++ b/offapi/com/sun/star/sdbc/XResultSetMetaDataSupplier.idl @@ -0,0 +1,115 @@ +/************************************************************************* + * + * $RCSfile: XResultSetMetaDataSupplier.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:57 $ + * + * 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_sdbc_XResultSetMetaDataSupplier_idl__ +#define __com_sun_star_sdbc_XResultSetMetaDataSupplier_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_sdbc_SQLException_idl__ +#include <com/sun/star/sdbc/SQLException.idl> +#endif + + module com { module sun { module star { module sdbc { + +interface XResultSetMetaData; + + +// DocMerge from xml: interface com::sun::star::sdbc::XResultSetMetaDataSupplier +/** provides access to the meta data of a result set. + + + <p>The number, types and properties of a ResultSet's columns are + provided by the ResultSetMetaData object returned by the getMetaData + method.</p> + */ +[ uik(7AD700A0-95B4-11d3-9EE20010-5AD7A5C4), + ident("XResultSetMetaDataSupplier", 1.0) ] +interface XResultSetMetaDataSupplier: com::sun::star::uno::XInterface +{ + + // DocMerge from xml: method com::sun::star::sdbc::XResultSetMetaDataSupplier::getMetaData + /** retrieves the number, types and properties of a ResultSet's columns. + */ + XResultSetMetaData getMetaData() raises (SQLException); +}; + +//============================================================================= + +}; }; }; }; + +/*=========================================================================== + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:43 hjs + initial import + + Revision 1.4 2000/09/11 11:52:43 mi + documentation merged from XML + + Revision 1.2 1999/12/01 18:26:22 dg + #70248# XColumnLocate new + + Revision 1.1 1999/11/24 08:41:09 dg + new StarDataBaseConnectivity + +===========================================================================*/ +#endif diff --git a/offapi/com/sun/star/sdbc/XResultSetUpdate.idl b/offapi/com/sun/star/sdbc/XResultSetUpdate.idl new file mode 100644 index 000000000000..50bfd144d3d9 --- /dev/null +++ b/offapi/com/sun/star/sdbc/XResultSetUpdate.idl @@ -0,0 +1,171 @@ +/************************************************************************* + * + * $RCSfile: XResultSetUpdate.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:57 $ + * + * 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_sdbc_XResultSetUpdate_idl__ +#define __com_sun_star_sdbc_XResultSetUpdate_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_sdbc_SQLException_idl__ +#include <com/sun/star/sdbc/SQLException.idl> +#endif + + module com { module sun { module star { module sdbc { + + +// DocMerge from xml: interface com::sun::star::sdbc::XResultSetUpdate +/** provides the possiblity to write changes mode on a result set back to + database. + */ +[ uik(D6B6024A-9067-11d3-9EE00010-5AD7A5C4), ident("XResultSetUpdate", 1.0) ] +interface XResultSetUpdate: com::sun::star::uno::XInterface +{ + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XResultSetUpdate::insertRow + /** inserts the contents of the insert row into the result set and + the database. Must be on the insert row when this method is called. + */ + void insertRow() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XResultSetUpdate::updateRow + /** updates the underlying database with the new contents of the + current row. Cannot be called when on the insert row. + */ + void updateRow() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XResultSetUpdate::deleteRow + /** deletes the current row from the result set and the underlying + database. Cannot be called when on the insert row. + */ + void deleteRow() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XResultSetUpdate::cancelRowUpdates + /** cancels the updates made to a row. + + + <p>This method may be called after calling an + <code>updateXXX</code> method(s) and before calling <code>updateRow</code> + to rollback the updates made to a row. If no updates have been made or + <code>updateRow</code> has already been called, then this method has no + effect. + </p> + */ + void cancelRowUpdates() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XResultSetUpdate::moveToInsertRow + /** moves the cursor to the insert row. The current cursor position is + remembered while the cursor is positioned on the insert row. + + + <p> The insert row is a special row associated with an updatable + result set. It is essentially a buffer where a new row may + be constructed by calling the <code>updateXXX</code> methods prior to + inserting the row into the result set. + </p> + <p>Only the <code>updateXXX</code>, <code>getXXX</code>, + and <code>insertRow</code> methods may be + called when the cursor is on the insert row. All of the columns in + a result set must be given a value each time this method is + called before calling <code>insertRow</code>. + The method <code>updateXXX</code> must be called before a + <code>getXXX</code> method can be called on a column value. + </p> + */ + void moveToInsertRow() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XResultSetUpdate::moveToCurrentRow + /** moves the cursor to the remembered cursor position, usually the + current row. This method has no effect if the cursor is not on the insert + row. + */ + void moveToCurrentRow() raises (SQLException); +}; + +//============================================================================= + +}; }; }; }; + +/*=========================================================================== + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:43 hjs + initial import + + Revision 1.5 2000/09/11 11:52:43 mi + documentation merged from XML + + Revision 1.3 2000/01/27 08:35:29 dg + #72102# documentation of insertRow() + + Revision 1.2 2000/01/06 07:27:42 dg + #70278# rowDeleted moved to XResultSet + + Revision 1.1 1999/11/24 08:41:08 dg + new StarDataBaseConnectivity + +===========================================================================*/ +#endif diff --git a/offapi/com/sun/star/sdbc/XRow.idl b/offapi/com/sun/star/sdbc/XRow.idl new file mode 100644 index 000000000000..2b405e5b6b5f --- /dev/null +++ b/offapi/com/sun/star/sdbc/XRow.idl @@ -0,0 +1,299 @@ +/************************************************************************* + * + * $RCSfile: XRow.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:57 $ + * + * 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_sdbc_XRow_idl__ +#define __com_sun_star_sdbc_XRow_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_util_Date_idl__ +#include <com/sun/star/util/Date.idl> +#endif + +#ifndef __com_sun_star_util_DateTime_idl__ +#include <com/sun/star/util/DateTime.idl> +#endif + +#ifndef __com_sun_star_util_Time_idl__ +#include <com/sun/star/util/Time.idl> +#endif + + module com { module sun { module star { module io { +interface XInputStream; +};};};}; + + module com { module sun { module star { module container { +interface XNameAccess; +};};};}; + +#ifndef __com_sun_star_sdbc_SQLException_idl__ +#include <com/sun/star/sdbc/SQLException.idl> +#endif + + module com { module sun { module star { module sdbc { + +interface XRef; +interface XArray; +interface XBlob; +interface XClob; + + +// DocMerge from xml: interface com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::XRow +/** is used to access data which is collected in a row. + */ +[ uik(D6B60247-9067-11d3-9EE00010-5AD7A5C4), ident("XRow", 1.0) ] +interface XRow: com::sun::star::uno::XInterface +{ + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::XRow::wasNull + /** reports whether the last column read had a value of SQL NULL. + Note that you must first call getXXX on a column to try to read + its value and then call wasNull() to see if the value read was + SQL NULL. + */ + boolean wasNull() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::XRow::getString + /** gets the value of a column in the current row as a String. + */ + string getString([in]long columnIndex) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::XRow::getBoolean + /** gets the value of a column in the current row as boolean. + */ + boolean getBoolean([in]long columnIndex) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::XRow::getByte + /** get the value of a column in the current row as a byte. + */ + byte getByte([in]long columnIndex) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::XRow::getShort + /** gets the value of a column in the current row as a short. + */ + short getShort([in]long columnIndex) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::XRow::getInt + /** get the value of a column in the current row as a Integer. + */ + long getInt([in]long columnIndex) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::XRow::getLong + /** get the value of a column in the current row as a Long. + */ + hyper getLong([in]long columnIndex) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::XRow::getFloat + /** gets the value of a column in the current row as a float. + */ + float getFloat([in]long columnIndex) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::XRow::getDouble + /** gets the value of a column in the current row as a double. + */ + double getDouble([in]long columnIndex) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from idl: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::XRow::getBytes + /** gets the value of a column in the current row as a byte array. + The bytes represent the raw values returned by the driver. + @param columnIndex + the first column is 1, the second is 2, ... + @returns + the column value; if the value is SQL NULL, the result is empty. + @throws SQLException + if a database access error occurs. + */ + sequence<byte> getBytes([in]long columnIndex) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::XRow::getDate + /** gets the value of a column in the current row as a date object. + */ + com::sun::star::util::Date getDate([in]long columnIndex) + raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::XRow::getTime + /** gets the value of a column in the current row as a time object. + */ + com::sun::star::util::Time getTime([in]long columnIndex) + raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::XRow::getTimestamp + /** gets the value of a column in the current row as a datetime object. + */ + com::sun::star::util::DateTime getTimestamp([in]long columnIndex) + raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::XRow::getBinaryStream + /** gets the value of a column in the current row as a stream of + uninterpreted bytes. The value can then be read in chunks from the + stream. This method is particularly suitable for retrieving large + LONGVARBINARY values. + + + <p> + <b>Note:</b> All the data in the returned stream must be + read prior to getting the value of any other column. The next + call to a get method implicitly closes the stream. Also, a + stream may return 0 when the method <code>available</code> + is called whether there is data + available or not. + </p> + */ + com::sun::star::io::XInputStream getBinaryStream([in]long columnIndex) + raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::XRow::getCharacterStream + /** gets the value of a column in the current row as a stream of + uninterpreted bytes. The value can then be read in chunks from the + stream. This method is particularly suitable for retrieving large + LONGVARBINARY or LONGVARCHAR values. + + + <p> + <b>Note:</b> All the data in the returned stream must be + read prior to getting the value of any other column. The next + call to a get method implicitly closes the stream. Also, a + stream may return 0 when the method <code>available</code> + is called whether there is data + available or not. + </p> + */ + com::sun::star::io::XInputStream getCharacterStream([in]long columnIndex) + raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::XRow::getObject + /** returns the value of a column in the current row as an object. + This method uses the given <code>Map</code> object + for the custom mapping of the SQL structure or distinct type + that is being retrieved. + */ + any getObject([in]long columnIndex, + [in]com::sun::star::container::XNameAccess typeMap) + raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::XRow::getRef + /** gets a REF(&lt;structured-type&gt;) column value from the current row. + */ + XRef getRef([in]long columnIndex) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::XRow::getBlob + /** gets a BLOB value in the current row. + */ + XBlob getBlob([in]long columnIndex) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::XRow::getClob + /** gets a CLOB value in the current row of this <code>ResultSet</code> object. + */ + XClob getClob([in]long columnIndex) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::XRow::getArray + /** gets a SQL ARRAY value from the current row of this <code>ResultSet</code> object. + */ + XArray getArray([in]long columnIndex) raises (SQLException); +}; + +//============================================================================= + +}; }; }; }; + +/*=========================================================================== + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:43 hjs + initial import + + Revision 1.6 2000/09/11 11:52:43 mi + documentation merged from XML + + Revision 1.4 1999/12/20 16:11:35 dg + #70278# changes in API + + Revision 1.3 1999/12/13 13:47:55 dg + #70278# XSQLErrorBroadcaster removed + + Revision 1.2 1999/11/24 11:33:26 dg + chk includes + + Revision 1.1 1999/11/24 08:41:09 dg + new StarDataBaseConnectivity + +===========================================================================*/ +#endif diff --git a/offapi/com/sun/star/sdbc/XRowSet.idl b/offapi/com/sun/star/sdbc/XRowSet.idl new file mode 100644 index 000000000000..bea7aef2aac7 --- /dev/null +++ b/offapi/com/sun/star/sdbc/XRowSet.idl @@ -0,0 +1,129 @@ +/************************************************************************* + * + * $RCSfile: XRowSet.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:57 $ + * + * 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_sdbc_XRowSet_idl__ +#define __com_sun_star_sdbc_XRowSet_idl__ + +#ifndef __com_sun_star_sdbc_XResultSet_idl__ +#include <com/sun/star/sdbc/XResultSet.idl> +#endif + + module com { module sun { module star { module sdbc { + +interface XRowSetListener; +interface XConnection; + + +// DocMerge from xml: interface com::sun::star::sdbc::XRowSet +/** enhances the functionality of a result set. It allows implementation of + a special behaviour for a result set and notifies an application on + certain row set events such as a change in its value. + + + + <p>The XRowSet interface is unique in that it is intended to be + a software layer on top of an SDBC driver. Implementations of the + RowSet interface can be provided by anyone.</p> + */ +[ uik(C76294D0-96B3-11d3-9EE40010-5AD7A5C4), ident("XRowSet", 1.0) ] +interface XRowSet: XResultSet +{ + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XRowSet::execute + /** populates a row set with data. The description of the data source and + other important information for filling the row set with data. + */ + void execute() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XRowSet::addRowSetListener + /** adds the specified listener to receive the events "cursorMoved", + "rowChanged", and "rowSetChanged". + */ + [oneway] void addRowSetListener([in]XRowSetListener listener ); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XRowSet::removeRowSetListener + /** removes the specified listener. + */ + [oneway] void removeRowSetListener([in]XRowSetListener listener ); +}; + +//============================================================================= + +}; }; }; }; + +/*=========================================================================== + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:43 hjs + initial import + + Revision 1.4 2000/09/11 11:52:43 mi + documentation merged from XML + + Revision 1.2 1999/12/14 12:05:46 dg + #70278# CompareBookmark removed + + Revision 1.1 1999/11/24 08:41:10 dg + new StarDataBaseConnectivity + +===========================================================================*/ +#endif diff --git a/offapi/com/sun/star/sdbc/XRowSetListener.idl b/offapi/com/sun/star/sdbc/XRowSetListener.idl new file mode 100644 index 000000000000..6de686b858c2 --- /dev/null +++ b/offapi/com/sun/star/sdbc/XRowSetListener.idl @@ -0,0 +1,123 @@ +/************************************************************************* + * + * $RCSfile: XRowSetListener.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:57 $ + * + * 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_sdbc_XRowSetListener_idl__ +#define __com_sun_star_sdbc_XRowSetListener_idl__ + +#ifndef __com_sun_star_lang_XEventListener_idl__ +#include <com/sun/star/lang/XEventListener.idl> +#endif + + module com { module sun { module star { module sdbc { + + +// DocMerge from xml: interface com::sun::star::sdbc::XRowSetListener +/** is used for receiving "cursorMoved", "rowChanged", and "rowSetChanged" events + posted by e.g. by a rowset. + */ +[ uik(186AF2E5-9C2E-11d3-9ED30050-04D8BBD0), ident("XRowSetListener", 1.0) ] +interface XRowSetListener: com::sun::star::lang::XEventListener +{ + + // DocMerge from xml: method com::sun::star::sdbc::XRowSetListener::cursorMoved + /** is called when a rowset's cursor is moved. + */ + [oneway] void cursorMoved([in]com::sun::star::lang::EventObject event); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XRowSetListener::rowChanged + /** is called when a row is inserted, updated, or deleted. + */ + [oneway] void rowChanged([in]com::sun::star::lang::EventObject event); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XRowSetListener::rowSetChanged + /** is called when the row set has changed, or in other words, when the row set has + been reexecuted. + */ + [oneway] void rowSetChanged([in]com::sun::star::lang::EventObject event); +}; + +//============================================================================= + +}; }; }; }; + +/*=========================================================================== + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:43 hjs + initial import + + Revision 1.6 2000/09/11 11:52:44 mi + documentation merged from XML + + Revision 1.4 2000/01/10 09:42:15 dg + #70278# Event changes + + Revision 1.3 1999/12/14 12:05:46 dg + #70278# CompareBookmark removed + + Revision 1.2 1999/11/26 17:31:30 fs + rowSetChanging + + Revision 1.1 1999/11/24 08:41:11 dg + new StarDataBaseConnectivity + +===========================================================================*/ +#endif diff --git a/offapi/com/sun/star/sdbc/XRowUpdate.idl b/offapi/com/sun/star/sdbc/XRowUpdate.idl new file mode 100644 index 000000000000..4ba2158dd1f7 --- /dev/null +++ b/offapi/com/sun/star/sdbc/XRowUpdate.idl @@ -0,0 +1,241 @@ +/************************************************************************* + * + * $RCSfile: XRowUpdate.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:57 $ + * + * 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_sdbc_XRowUpdate_idl__ +#define __com_sun_star_sdbc_XRowUpdate_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_util_Date_idl__ +#include <com/sun/star/util/Date.idl> +#endif + +#ifndef __com_sun_star_util_DateTime_idl__ +#include <com/sun/star/util/DateTime.idl> +#endif + +#ifndef __com_sun_star_util_Time_idl__ +#include <com/sun/star/util/Time.idl> +#endif + + module com { module sun { module star { module io { +interface XInputStream; +};};};}; + +#ifndef __com_sun_star_sdbc_SQLException_idl__ +#include <com/sun/star/sdbc/SQLException.idl> +#endif + + module com { module sun { module star { module sdbc { + + +// DocMerge from xml: interface com::sun::star::io::com::sun::star::sdbc::XRowUpdate +/** is used to update data which is collected in a row. + */ +[ uik(D6B60248-9067-11d3-9EE00010-5AD7A5C4), ident("XRowUpdate", 1.0) ] +interface XRowUpdate: com::sun::star::uno::XInterface +{ + + // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XRowUpdate::updateNull + /** gives a nullable column a null value. + */ + void updateNull([in]long columnIndex) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XRowUpdate::updateBoolean + /** updates a column with a boolean value. + */ + void updateBoolean([in]long columnIndex, [in]boolean x) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XRowUpdate::updateByte + /** updates a column with a byte value. + */ + void updateByte([in]long columnIndex, [in]byte x) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XRowUpdate::updateShort + /** updates a column with a short value. + */ + void updateShort([in]long columnIndex, [in]short x) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XRowUpdate::updateInt + /** updates a column with an long value. + */ + void updateInt([in]long columnIndex, [in]long x) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XRowUpdate::updateLong + /** updates a column with a hyper value. + */ + void updateLong([in]long columnIndex, [in]hyper x) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XRowUpdate::updateFloat + /** updates a column with a float value. + */ + void updateFloat([in]long columnIndex, [in]float x) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XRowUpdate::updateDouble + /** updates a column with a Double value. + */ + void updateDouble([in]long columnIndex, [in]double x) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XRowUpdate::updateString + /** updates a column with a String value. + */ + void updateString([in]long columnIndex, [in]string x) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XRowUpdate::updateBytes + /** updates a column with a byte array value. + */ + void updateBytes([in]long columnIndex, [in]sequence<byte> x) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XRowUpdate::updateDate + /** updates a column with a Date value. + */ + void updateDate([in]long columnIndex, [in]com::sun::star::util::Date x) + raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XRowUpdate::updateTime + /** updates a column with a Time value. + */ + void updateTime([in]long columnIndex, [in]com::sun::star::util::Time x) + raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XRowUpdate::updateTimestamp + /** updates a column with a Timestamp value. + */ + void updateTimestamp([in]long columnIndex, + [in]com::sun::star::util::DateTime x) + raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XRowUpdate::updateBinaryStream + /** updates a column with a stream value. + */ + void updateBinaryStream([in]long columnIndex, + [in]com::sun::star::io::XInputStream x, + [in]long length) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XRowUpdate::updateCharacterStream + /** updates a column with a stream value. + */ + void updateCharacterStream([in]long columnIndex, + [in]com::sun::star::io::XInputStream x, + [in]long length) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XRowUpdate::updateObject + /** updates a column with an Object value. + */ + void updateObject([in]long columnIndex, [in]any x) + raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XRowUpdate::updateNumericObject + /** updates a column with an Object value. + */ + void updateNumericObject([in]long columnIndex, [in]any x, [in]long scale) + raises (SQLException); +}; + +//============================================================================= + +}; }; }; }; + +/*=========================================================================== + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:43 hjs + initial import + + Revision 1.8 2000/09/11 11:52:44 mi + documentation merged from XML + + Revision 1.6 2000/01/28 07:57:04 dg + #72121# documentation of update/setCharacterStream + + Revision 1.5 1999/12/20 16:11:35 dg + #70278# changes in API + + Revision 1.4 1999/12/14 12:05:46 dg + #70278# CompareBookmark removed + + Revision 1.3 1999/12/13 13:47:55 dg + #70278# XSQLErrorBroadcaster removed + + Revision 1.2 1999/11/24 11:33:26 dg + chk includes + + Revision 1.1 1999/11/24 08:41:12 dg + new StarDataBaseConnectivity + +===========================================================================*/ +#endif diff --git a/offapi/com/sun/star/sdbc/XSQLData.idl b/offapi/com/sun/star/sdbc/XSQLData.idl new file mode 100644 index 000000000000..8da8f5c379eb --- /dev/null +++ b/offapi/com/sun/star/sdbc/XSQLData.idl @@ -0,0 +1,165 @@ +/************************************************************************* + * + * $RCSfile: XSQLData.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:57 $ + * + * 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_sdbc_XSQLData_idl__ +#define __com_sun_star_sdbc_XSQLData_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_sdbc_SQLException_idl__ +#include <com/sun/star/sdbc/SQLException.idl> +#endif + + module com { module sun { module star { module sdbc { + +interface XSQLInput; +interface XSQLOutput; + + +// DocMerge from xml: interface com::sun::star::sdbc::XSQLData +/** 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> + */ +[ uik(D6B6023E-9067-11d3-9EE00010-5AD7A5C4), ident("XSQLData", 1.0) ] +interface XSQLData: com::sun::star::uno::XInterface +{ + + // DocMerge from xml: method com::sun::star::sdbc::XSQLData::getSQLTypeName + /** 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> + */ + string getSQLTypeName() raises (SQLException); + + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XSQLData::readSQL + /** 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>@see com::sun::star::sdbc::XSQLInput + */ + void readSQL([in]XSQLInput stream, [in]string typeName) + raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XSQLData::writeSQL + /** 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>@see com::sun::star::sdbc::XSQLOutput + */ + void writeSQL([in]XSQLOutput stream) raises (SQLException); +}; + +//============================================================================= + +}; }; }; }; + +/*=========================================================================== + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:43 hjs + initial import + + Revision 1.3 2000/09/11 11:52:44 mi + documentation merged from XML + + Revision 1.1 1999/11/24 08:41:12 dg + new StarDataBaseConnectivity + +===========================================================================*/ +#endif diff --git a/offapi/com/sun/star/sdbc/XSQLInput.idl b/offapi/com/sun/star/sdbc/XSQLInput.idl new file mode 100644 index 000000000000..6ee339fca76b --- /dev/null +++ b/offapi/com/sun/star/sdbc/XSQLInput.idl @@ -0,0 +1,285 @@ +/************************************************************************* + * + * $RCSfile: XSQLInput.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:57 $ + * + * 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_sdbc_XSQLInput_idl__ +#define __com_sun_star_sdbc_XSQLInput_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_util_Date_idl__ +#include <com/sun/star/util/Date.idl> +#endif + +#ifndef __com_sun_star_util_DateTime_idl__ +#include <com/sun/star/util/DateTime.idl> +#endif + +#ifndef __com_sun_star_util_Time_idl__ +#include <com/sun/star/util/Time.idl> +#endif + + module com { module sun { module star { module io { +interface XInputStream; +};};};}; + +#ifndef __com_sun_star_sdbc_SQLException_idl__ +#include <com/sun/star/sdbc/SQLException.idl> +#endif + + module com { module sun { module star { module sdbc { + +interface XRef; +interface XArray; +interface XBlob; +interface XClob; + + +// DocMerge from xml: interface com::sun::star::io::com::sun::star::sdbc::XSQLInput +/** represents an input stream that contains a stream of values representing an + instance of a SQL structured or distinct type. + + + <p>This interface, used only for custom mapping, is used by the driver + behind the scenes, and a programmer never directly invokes + <code>SQLInput</code> methods. + </p> + <p>When the method <code>getObject</code> is called with an + object of a service implementing the interface <code>SQLData</code>, + the SDBC driver calls the method <code>XSQLData.getSQLType</code> + to determine the SQL type of the user-defined type (UDT) being custom mapped. + The driver creates an instance of <code>XSQLInput</code>, + populating it with the attributes of the UDT. The driver then passes the input + stream to the method <code>XSQLData.readSQL</code>, which in turn + calls the <code>XSQLInput.readXXX</code> methods in its implementation for + reading the attributes from the input stream.</p> + */ +[ uik(D6B6023F-9067-11d3-9EE00010-5AD7A5C4), ident("XSQLInput", 1.0) ] +interface XSQLInput: com::sun::star::uno::XInterface +{ + + // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLInput::readString + /** reads the next attribute in the stream as string. + */ + string readString() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLInput::readBoolean + /** reads the next attribute in the stream as boolean. + */ + boolean readBoolean() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLInput::readByte + /** reads the next attribute in the stream as byte. + */ + byte readByte() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLInput::readShort + /** reads the next attribute in the stream as short. + */ + short readShort() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLInput::readInt + /** reads the next attribute in the stream as long. + */ + long readInt() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLInput::readLong + /** reads the next attribute in the stream as hyper. + */ + hyper readLong() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLInput::readFloat + /** reads the next attribute in the stream as float. + */ + float readFloat() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLInput::readDouble + /** reads the next attribute in the stream as double. + */ + double readDouble() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from idl: method com::sun::star::io::com::sun::star::sdbc::XSQLInput::readBytes + /** reads the next attribute in the stream as sequence of bytes. + @throws SQLException + if a database access error occurs + */ + sequence<byte> readBytes() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLInput::readDate + /** reads the next attribute in the stream as date. + */ + com::sun::star::util::Date readDate() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLInput::readTime + /** reads the next attribute in the stream as time. + */ + com::sun::star::util::Time readTime() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLInput::readTimestamp + /** reads the next attribute in the stream as DateTime. + */ + com::sun::star::util::DateTime readTimestamp() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLInput::readBinaryStream + /** reads the next attribute in the stream as sequence of bytes. + */ + com::sun::star::io::XInputStream readBinaryStream() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLInput::readCharacterStream + /** reads the next attribute in the stream as a unicode string. + */ + com::sun::star::io::XInputStream readCharacterStream() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLInput::readObject + /** returns the datum at the head of the stream as an any. + + + <p>The actual type of the any returned is determined by the default + type mapping, and any customizations present in this stream's type map. + + <br>A type map is registered with the stream by the SDBC driver before the + stream is passed to the application. + + <br>When the datum at the head of the stream is a SQL NULL, + the method returns <void></void>. If the datum is a SQL structured or distinct + type, it determines the SQL type of the datum at the head of the stream, + constructs an object of the appropriate service, and calls the method + <code>XSQLData.readSQL</code> on that object, which reads additional data + from the stream using the protocol described for that method. + + </p> + */ + any readObject() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLInput::readRef + /** reads a REF(&lt;structured-type&gt;) from the stream. + */ + XRef readRef() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLInput::readBlob + /** reads a BLOB from the stream. + */ + XBlob readBlob() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLInput::readClob + /** reads a CLOB from the stream. + */ + XClob readClob() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLInput::readArray + /** reads an array from the stream. + */ + XArray readArray() raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLInput::wasNull + /** determines whether the last value read was null. + */ + boolean wasNull() raises (SQLException); +}; + +//============================================================================= + +}; }; }; }; + +/*=========================================================================== + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:43 hjs + initial import + + Revision 1.7 2000/09/11 11:52:44 mi + documentation merged from XML + + Revision 1.5 2000/01/14 10:41:30 mi + XML syntax error in documentation + + Revision 1.4 1999/12/20 16:11:35 dg + #70278# changes in API + + Revision 1.3 1999/12/13 13:47:55 dg + #70278# XSQLErrorBroadcaster removed + + Revision 1.2 1999/11/24 11:33:26 dg + chk includes + + Revision 1.1 1999/11/24 08:41:12 dg + new StarDataBaseConnectivity + +===========================================================================*/ +#endif diff --git a/offapi/com/sun/star/sdbc/XSQLOutput.idl b/offapi/com/sun/star/sdbc/XSQLOutput.idl new file mode 100644 index 000000000000..775a37513243 --- /dev/null +++ b/offapi/com/sun/star/sdbc/XSQLOutput.idl @@ -0,0 +1,286 @@ +/************************************************************************* + * + * $RCSfile: XSQLOutput.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:57 $ + * + * 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_sdbc_XSQLOutput_idl__ +#define __com_sun_star_sdbc_XSQLOutput_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_util_Date_idl__ +#include <com/sun/star/util/Date.idl> +#endif + +#ifndef __com_sun_star_util_DateTime_idl__ +#include <com/sun/star/util/DateTime.idl> +#endif + +#ifndef __com_sun_star_util_Time_idl__ +#include <com/sun/star/util/Time.idl> +#endif + + module com { module sun { module star { module io { +interface XInputStream; +};};};}; + +#ifndef __com_sun_star_sdbc_SQLException_idl__ +#include <com/sun/star/sdbc/SQLException.idl> +#endif + + module com { module sun { module star { module sdbc { + +interface XRef; +interface XArray; +interface XBlob; +interface XClob; +interface XStruct; +interface XSQLData; + + +// DocMerge from xml: interface com::sun::star::io::com::sun::star::sdbc::XSQLOutput +/** is used as an output stream for writing the attributes of a user-defined + type back to the database. This interface, used only for custom mapping, + is used by the driver, and its methods are never directly invoked + by a programmer. + + + <p>When an object of a class implementing interface <code>XSQLData</code> is + passed as an argument to a SQL statement, the JDBC driver calls + <code>SQLData.getSQLType</code> to determine the kind of SQL datum being + passed to the database. + <br>The driver then creates an instance of <code>XSQLOutput</code> and + passes it to the method <code>SQLData.writeSQL</code>. + The method <code>writeSQL</code> in turn calls the + appropriate <code>SQLOutput.writeXXX</code> methods + to write data from the <code>SQLData</code> object to + the <code>SQLOutput</code> output stream as the + representation of a SQL user-defined type.</p> + */ +[ uik(D6B60240-9067-11d3-9EE00010-5AD7A5C4), ident("XSQLOutput", 1.0) ] +interface XSQLOutput: com::sun::star::uno::XInterface +{ + + // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLOutput::writeString + /** writes the next attribute to the stream as a string. + */ + void writeString([in]string x) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLOutput::writeBoolean + /** writes the next attribute to the stream as boolean. + */ + void writeBoolean([in]boolean x) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLOutput::writeByte + /** writes the next attribute to the stream as byte. + */ + void writeByte([in]byte x) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLOutput::writeShort + /** writes the next attribute to the stream as short. + */ + void writeShort([in]short x) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLOutput::writeInt + /** writes the next attribute to the stream as long. + */ + void writeInt([in]long x) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLOutput::writeLong + /** writes the next attribute to the stream as hyper. + */ + void writeLong([in]hyper x) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLOutput::writeFloat + /** writes the next attribute to the stream as float. + */ + void writeFloat([in]float x) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLOutput::writeDouble + /** writes the next attribute to the stream as double. + */ + void writeDouble([in]double x) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLOutput::writeBytes + /** writes the next attribute to the stream as byte sequence. + */ + void writeBytes([in]sequence<byte> x) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLOutput::writeDate + /** writes the next attribute to the stream as a date. + */ + void writeDate([in]com::sun::star::util::Date x) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLOutput::writeTime + /** writes the next attribute to the stream as a time. + */ + void writeTime([in]com::sun::star::util::Time x) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLOutput::writeTimestamp + /** writes the next attribute to the stream as a datetime. + */ + void writeTimestamp([in]com::sun::star::util::DateTime x) + raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLOutput::writeBinaryStream + /** writes the next attribute to the stream as a stream of uninterpreted + bytes. + */ + void writeBinaryStream([in]com::sun::star::io::XInputStream x) + raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLOutput::writeCharacterStream + /** writes the next attribute to the stream as a stream of unicode string. + */ + void writeCharacterStream([in]com::sun::star::io::XInputStream x) + raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLOutput::writeObject + /** writes to the stream the data contained in the given + <code>XSQLData</code> object. + + + <p>When the <code>XSQLData</code> object is <null></null>, this + method writes an SQL NULL to the stream. + Otherwise, it calls the <code>SQLData.writeSQL</code> + method of the given object, which + writes the object's attributes to the stream. + The implementation of the method <code>XSQLData.writeSQL</code> + calls the appropriate <code>XSQLOutput.writeXXX</code> method(s) + for writing each of the object's attributes in order. + <br>The attributes must be read from an <code>XSQLInput</code> + input stream and written to an <code>XSQLOutput</code> + output stream in the same order in which they were + listed in the SQL definition of the user-defined type. + </p> + */ + void writeObject([in]XSQLData x) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLOutput::writeRef + /** writes a REF(&lt;structured-type&gt;) to the stream. + */ + void writeRef([in]XRef x) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLOutput::writeBlob + /** writes a BLOB to the stream. + */ + void writeBlob([in]XBlob x) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLOutput::writeClob + /** writes a CLOB to the stream. + */ + void writeClob([in]XClob x) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLOutput::writeStruct + /** writes a structured-type to the stream. + */ + void writeStruct([in]XStruct x) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLOutput::writeArray + /** writes an array to the stream. + */ + void writeArray([in]XArray x) raises (SQLException); +}; + +//============================================================================= + +}; }; }; }; + +/*=========================================================================== + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:43 hjs + initial import + + Revision 1.6 2000/09/11 11:52:44 mi + documentation merged from XML + + Revision 1.4 1999/12/20 16:11:35 dg + #70278# changes in API + + Revision 1.3 1999/12/13 13:47:55 dg + #70278# XSQLErrorBroadcaster removed + + Revision 1.2 1999/11/24 11:33:27 dg + chk includes + + Revision 1.1 1999/11/24 08:41:13 dg + new StarDataBaseConnectivity + +===========================================================================*/ +#endif diff --git a/offapi/com/sun/star/sdbc/XStatement.idl b/offapi/com/sun/star/sdbc/XStatement.idl new file mode 100644 index 000000000000..2128e4d71760 --- /dev/null +++ b/offapi/com/sun/star/sdbc/XStatement.idl @@ -0,0 +1,151 @@ +/************************************************************************* + * + * $RCSfile: XStatement.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:57 $ + * + * 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_sdbc_XStatement_idl__ +#define __com_sun_star_sdbc_XStatement_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_sdbc_SQLException_idl__ +#include <com/sun/star/sdbc/SQLException.idl> +#endif + + module com { module sun { module star { module sdbc { + +interface XConnection; +interface XResultSet; + + +// DocMerge from xml: interface com::sun::star::sdbc::XStatement +/** is used for executing a static SQL statement and obtaining the results + produced by it. + + + + <p>Only one ResultSet per Statement can be open at any point in + time. Therefore, if the reading of one ResultSet is interleaved + with the reading of another, each must have been generated by + different Statements. All statement <code>execute</code> methods implicitly + close a statement's current ResultSet if an open one exists.</p> + */ +[ uik(D6B60242-9067-11d3-9EE00010-5AD7A5C4), ident("XStatement", 1.0) ] +interface XStatement: com::sun::star::uno::XInterface +{ + + // DocMerge from xml: method com::sun::star::sdbc::XStatement::executeQuery + /** executes a SQL statement that returns a single ResultSet. + */ + XResultSet executeQuery([in]string sql) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XStatement::executeUpdate + /** executes an SQL INSERT, UPDATE, or DELETE statement. In addition, + SQL statements that return nothing, such as SQL DDL statements, + can be executed. + */ + long executeUpdate([in]string sql) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XStatement::execute + /** executes a SQL statement that may return multiple results. + + + <p>Under some (uncommon) situations a single SQL statement may return + multiple result sets and/or update counts. Normally you can ignore + this unless you are (1) executing a stored procedure that you know may + return multiple results or (2) you are dynamically executing an + unknown SQL string. The navigation through multiple results is covered by + <type scope="com::sun::star::sdbc">XMultipleResults</type>. + </p> + <p>The <code>execute</code> method executes a SQL statement and indicates + the form of the first result. You can then use <code>getResultSet</code> or + <code>getUpdateCount</code> to retrieve the result, and + <code>getMoreResults</code> to move to any subsequent result(s). + </p> + */ + boolean execute([in]string sql) raises (SQLException); + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XStatement::getConnection + /** returns the <code>Connection</code> object + that produced this <code>Statement</code> object. + */ + [const] XConnection getConnection() raises (SQLException); +}; + +//============================================================================= + +}; }; }; }; + +/*=========================================================================== + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:43 hjs + initial import + + Revision 1.3 2000/09/11 11:52:44 mi + documentation merged from XML + + Revision 1.1 1999/11/24 08:41:13 dg + new StarDataBaseConnectivity + +===========================================================================*/ +#endif diff --git a/offapi/com/sun/star/sdbc/XStruct.idl b/offapi/com/sun/star/sdbc/XStruct.idl new file mode 100644 index 000000000000..34c5bfb29937 --- /dev/null +++ b/offapi/com/sun/star/sdbc/XStruct.idl @@ -0,0 +1,141 @@ +/************************************************************************* + * + * $RCSfile: XStruct.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:57 $ + * + * 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_sdbc_XStruct_idl__ +#define __com_sun_star_sdbc_XStruct_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + + module com { module sun { module star { module container { +interface XNameAccess; +};};};}; + +#ifndef __com_sun_star_sdbc_SQLException_idl__ +#include <com/sun/star/sdbc/SQLException.idl> +#endif + + module com { module sun { module star { module sdbc { + + +// DocMerge from xml: interface com::sun::star::container::com::sun::star::sdbc::XStruct +/** is used for the standard mapping for a SQL structured type. + + + <p>A <code>Struct</code> object contains a value for each attribute + of the SQL structured type that it represents. + By default, an instance of <code>Struct</code> is valid as long as the + application has a reference to it.</p> + */ +[ uik(D6B6023D-9067-11d3-9EE00010-5AD7A5C4), ident("XStruct", 1.0) ] +interface XStruct: com::sun::star::uno::XInterface +{ + + // DocMerge from xml: method com::sun::star::container::com::sun::star::sdbc::XStruct::getSQLTypeName + /** retrieves the SQL type name of the SQL structured type + that this <code>Struct</code> object represents. + */ + string getSQLTypeName() raises (SQLException); + + //------------------------------------------------------------------------- + + // DocMerge from idl: method com::sun::star::container::com::sun::star::sdbc::XStruct::getAttributes + /** produces the ordered values of the attributes of the SQL + structured type that this <code>Struct</code> object represents. + <p>This method uses the given type map for customizations of the type + mappings. If there is no entry in the given type map that matches or + the given type map is <NULL/>, the structured type that this + <code>Struct</code> object represents, the driver uses + the connection type mapping. + @param typeMap + is a map object that contains mappings of SQL type names to + services. If the <code>typeMap</code> is <NULL/>, the type-map + associated with the connection for customizations of the type-mappings + is used. + @returns + an array containing the ordered attribute values. + @throws SQLException + if a database access error occurs. + */ + sequence<any> getAttributes([in]com::sun::star::container::XNameAccess typeMap) + raises (SQLException); +}; + +//============================================================================= + +}; }; }; }; + +/*=========================================================================== + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:43 hjs + initial import + + Revision 1.4 2000/09/11 11:52:44 mi + documentation merged from XML + + Revision 1.2 1999/11/24 11:33:27 dg + chk includes + + Revision 1.1 1999/11/24 08:41:13 dg + new StarDataBaseConnectivity + +===========================================================================*/ +#endif diff --git a/offapi/com/sun/star/sdbc/XWarningsSupplier.idl b/offapi/com/sun/star/sdbc/XWarningsSupplier.idl new file mode 100644 index 000000000000..1940fa1acb81 --- /dev/null +++ b/offapi/com/sun/star/sdbc/XWarningsSupplier.idl @@ -0,0 +1,125 @@ +/************************************************************************* + * + * $RCSfile: XWarningsSupplier.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:57 $ + * + * 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_sdbc_XWarningsSupplier_idl__ +#define __com_sun_star_sdbc_XWarningsSupplier_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_sdbc_SQLWarning_idl__ +#include <com/sun/star/sdbc/SQLWarning.idl> +#endif + + module com { module sun { module star { module sdbc { + + +// DocMerge from xml: interface com::sun::star::sdbc::XWarningsSupplier +/** should be implemented of objects which may report warnings or not critical + errors .@see com::sun::star::sdbc::SQLWarning + */ +[ uik(D6B60232-9067-11d3-9EE00010-5AD7A5C4), ident("XWarningsSupplier", 1.0) ] +interface XWarningsSupplier: com::sun::star::uno::XInterface +{ + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XWarningsSupplier::getWarnings + /** returns the first warning reported by calls on an object that supports + the usage of warnings. + + + + <p> + <b>Note:</b> Subsequent warnings will be chained to this + SQLWarning. + + </p> + */ + [const] any getWarnings() raises (SQLException); + + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sdbc::XWarningsSupplier::clearWarnings + /** clears all warnings reported for the object implementing the interface. + After a call to this method, the method <code>getWarnings</code> + returns <void></void> until a new warning is + reported for the object. + */ + void clearWarnings() raises (SQLException); +}; + +//============================================================================= + +}; }; }; }; + +/*=========================================================================== + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:43 hjs + initial import + + Revision 1.3 2000/09/11 11:52:44 mi + documentation merged from XML + + Revision 1.1 1999/11/24 08:41:14 dg + new StarDataBaseConnectivity + +===========================================================================*/ +#endif diff --git a/offapi/com/sun/star/sdbc/makefile.mk b/offapi/com/sun/star/sdbc/makefile.mk new file mode 100644 index 000000000000..189f69d29ff6 --- /dev/null +++ b/offapi/com/sun/star/sdbc/makefile.mk @@ -0,0 +1,140 @@ +#************************************************************************* +# +# $RCSfile: makefile.mk,v $ +# +# $Revision: 1.1 $ +# +# last change: $Author: mi $ $Date: 2000-11-06 09:21:57 $ +# +# 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): _______________________________________ +# +# +# +#************************************************************************* + +PRJ=..$/..$/..$/.. + +PRJNAME=api + +TARGET=csssdbc +PACKAGE=com$/sun$/star$/sdbc + +# --- Settings ----------------------------------------------------- +.INCLUDE : $(PRJ)$/util$/makefile.pmk + +# ------------------------------------------------------------------------ +IDLFILES=\ + BatchUpdateException.idl \ + BestRowScope.idl \ + BestRowType.idl \ + CallableStatement.idl \ + ColumnSearch.idl \ + ColumnType.idl \ + ColumnValue.idl \ + Connection.idl \ + DataTruncation.idl \ + DataType.idl \ + Deferrability.idl \ + Driver.idl \ + DriverManager.idl \ + DriverPropertyInfo.idl \ + FetchDirection.idl \ + IndexType.idl \ + KeyRule.idl \ + PreparedStatement.idl \ + ProcedureColumn.idl \ + ProcedureResult.idl \ + ResultSet.idl \ + ResultSetConcurrency.idl \ + ResultSetType.idl \ + RowSet.idl \ + SQLException.idl \ + SQLWarning.idl \ + Statement.idl \ + TransactionIsolation.idl \ + XArray.idl \ + XBatchExecution.idl \ + XBlob.idl \ + XColumnLocate.idl \ + XClob.idl \ + XCloseable.idl \ + XConnection.idl \ + XDatabaseMetaData.idl \ + XDataSource.idl \ + XDriver.idl \ + XDriverAccess.idl \ + XDriverManager.idl \ + XMultipleResults.idl \ + XOutParameters.idl \ + XParameters.idl \ + XPreparedBatchExecution.idl \ + XPreparedStatement.idl \ + XRef.idl \ + XResultSet.idl \ + XResultSetMetaData.idl \ + XResultSetMetaDataSupplier.idl \ + XResultSetUpdate.idl \ + XRow.idl \ + XRowSet.idl \ + XRowSetListener.idl \ + XRowUpdate.idl \ + XSQLData.idl \ + XSQLInput.idl \ + XSQLOutput.idl \ + XStatement.idl \ + XStruct.idl \ + XWarningsSupplier.idl + +# ------------------------------------------------------------------ +.INCLUDE : target.mk +.INCLUDE : $(PRJ)$/util$/target.pmk + + |