offapi/com/sun/star/sdbc/ProcedureColumn.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: ProcedureColumn.idl,v $
  10  * $Revision: 1.10 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_sdbc_ProcedureColumn_idl__
  31 #define __com_sun_star_sdbc_ProcedureColumn_idl__
  32
  33  module com {  module sun {  module star {  module sdbc {
  34
  35
  36 /** indicates the type of a procedure column.
  37  */
  38 published constants ProcedureColumn
  39 {
  40
  41     /** indicates that the type of the column is unknown. A possible value for
  42              the column
  43              <code>COLUMN_TYPE</code>
  44              in the
  45              <type scope="com::sun::star::sdbc">XResultSet</type>
  46              returned by the method
  47              <member scope="com::sun::star::sdbc">XDatabaseMetaData::getProcedureColumns()</member>
  48              .
  49      */
  50     const long UNKNOWN                  = 0;
  51     //-------------------------------------------------------------------------
  52
  53     /** indicates that the column stores IN parameters.
  54              A possible value for the column
  55              <code>COLUMN_TYPE</code>
  56              in the
  57              <type scope="com::sun::star::sdbc">XResultSet</type>
  58              returned by the method
  59              <member scope="com::sun::star::sdbc">XDatabaseMetaData::getProcedureColumns()</member>
  60              .
  61      */
  62     const long IN                               = 1;
  63     //-------------------------------------------------------------------------
  64
  65     /** indicates that the column stores INOUT parameters.
  66              A possible value for the column
  67              <code>COLUMN_TYPE</code>
  68              in the
  69              <type scope="com::sun::star::sdbc">XResultSet</type>
  70              returned by the method
  71              <member scope="com::sun::star::sdbc">XDatabaseMetaData::getProcedureColumns()</member>
  72              .
  73      */
  74     const long INOUT                    = 2;
  75     //-------------------------------------------------------------------------
  76
  77     /** indicates that the column stores results.
  78              A possible value for the column
  79              <code>COLUMN_TYPE</code>
  80              in the
  81              <type scope="com::sun::star::sdbc">XResultSet</type>
  82              returned by the method
  83              <member scope="com::sun::star::sdbc">XDatabaseMetaData::getProcedureColumns()</member>
  84              .
  85      */
  86     const long RESULT                   = 3;
  87     //-------------------------------------------------------------------------
  88
  89     /** indicates that the column stores OUT parameters.
  90              A possible value for the column
  91              <code>COLUMN_TYPE</code>
  92              in the
  93              <type scope="com::sun::star::sdbc">XResultSet</type>
  94              returned by the method
  95              <member scope="com::sun::star::sdbc">XDatabaseMetaData::getProcedureColumns()</member>
  96              .
  97      */
  98     const long OUT                              = 4;
  99     //-------------------------------------------------------------------------
 100
 101     /** Indicates that the column stores return values.
 102              A possible value for the column
 103              <code>COLUMN_TYPE</code>
 104              in the
 105              <type scope="com::sun::star::sdbc">XResultSet</type>
 106              returned by the method
 107              <member scope="com::sun::star::sdbc">XDatabaseMetaData::getProcedureColumns()</member>
 108              .
 109      */
 110     const long RETURN                   = 5;
 111 };
 112
 113 //=============================================================================
 114
 115 }; }; }; };
 116
 117 /*===========================================================================
 118 ===========================================================================*/
 119 #endif