/************************************************************************* * * $RCSfile: XOutParameters.idl,v $ * * $Revision: 1.6 $ * * last change: $Author: hr $ $Date: 2003-03-26 13:55:30 $ * * 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 #endif #ifndef __com_sun_star_sdbc_SQLException_idl__ #include #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.

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.

*/ 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 XOutParameters::registerOutParameter() should be used for a user-named or REF output parameter. Examples of user-named types include: STRUCT, DISTINCT, OBJECT, and named array types.

Before executing a stored procedure call, you must explicitly call XOutParameters::registerOutParameter() to register the type from DataType for each OUT parameter.
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.

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.

Note: When reading the value of an out parameter, you must use the getXXX method whose type XXX corresponds to the parameter's registered SQL type.

@param parameterIndex the first parameter is 1, the second is 2, ... @param sqlType the type of the column to register @param typeName the name of the type @throws SQLException if a database access error occurs. */ 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 parameterIndex to the SDBC type sqlType . All OUT parameters must be registered before a stored procedure is executed.

The SDBC type specified by sqlType for an OUT parameter determines the type that must be used in the get method to read the value of that parameter. This version of XOutParameters::registerOutParameter() should be used when the parameter is of SDBC type DataType::NUMERIC or DataType::DECIMAL . @param parameterIndex the first parameter is 1, the second is 2, ... @param sqlType the type of the column to register @param scale the scale of the type @throws SQLException if a database access error occurs.

*/ void registerNumericOutParameter([in]long parameterIndex, [in]long sqlType, [in]long scale) raises (SQLException); }; //============================================================================= }; }; }; }; /*=========================================================================== ===========================================================================*/ #endif