diff options
Diffstat (limited to 'offapi/com/sun/star/sdbcx/XDataDefinitionSupplier.idl')
-rw-r--r-- | offapi/com/sun/star/sdbcx/XDataDefinitionSupplier.idl | 92 |
1 files changed, 92 insertions, 0 deletions
diff --git a/offapi/com/sun/star/sdbcx/XDataDefinitionSupplier.idl b/offapi/com/sun/star/sdbcx/XDataDefinitionSupplier.idl new file mode 100644 index 000000000000..3a1ad1010d99 --- /dev/null +++ b/offapi/com/sun/star/sdbcx/XDataDefinitionSupplier.idl @@ -0,0 +1,92 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org 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 version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ +#ifndef __com_sun_star_sdbcx_XDataDefinitionSupplier_idl__ +#define __com_sun_star_sdbcx_XDataDefinitionSupplier_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 { + published interface XConnection; +};};};}; + + module com { module sun { module star { module sdbcx { + + published interface XTablesSupplier; + + +/** provides the access to data definition beans from a connected database. + */ +published interface XDataDefinitionSupplier: com::sun::star::uno::XInterface +{ + + /** returns at least the container of tables related to the given connection. + @param connection + the related connection + @returns + the container + @throws com::sun::star::sdbc::SQLException + if a database access error occurs. + */ + XTablesSupplier getDataDefinitionByConnection( + [in]com::sun::star::sdbc::XConnection connection) + raises (com::sun::star::sdbc::SQLException); + //------------------------------------------------------------------------- + + /** returns at least the container of tables related to the given Database URL. + @param url + a database url of the form sdbc:subprotocol:subname + @param info + a list of arbitrary string tag/value pairs as connection arguments; + normally at least a "user" and "password" property should be included + @returns + the container + @throws com::sun::star::sdbc::SQLException + if a database access error occurs. + */ + XTablesSupplier getDataDefinitionByURL( + [in]string url, + [in]sequence<com::sun::star::beans::PropertyValue> info) + raises (com::sun::star::sdbc::SQLException); +}; + +//============================================================================= + +}; }; }; }; + +/*=========================================================================== +===========================================================================*/ +#endif |