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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20  module com {  module sun {  module star {  module sdbc {
  21
  22
  23 /** indicates the type of a procedure column.
  24  */
  25 published constants ProcedureColumn
  26 {
  27
  28     /** indicates that the type of the column is unknown. A possible value for
  29              the column
  30              <code>COLUMN_TYPE</code>
  31              in the
  32              com::sun::star::sdbc::XResultSet
  33              returned by the method
  34              com::sun::star::sdbc::XDatabaseMetaData::getProcedureColumns().
  35      */
  36     const long UNKNOWN          = 0;
  37
  38     /** indicates that the column stores IN parameters.
  39              A possible value for the column
  40              <code>COLUMN_TYPE</code>
  41              in the
  42              com::sun::star::sdbc::XResultSet
  43              returned by the method
  44              com::sun::star::sdbc::XDatabaseMetaData::getProcedureColumns().
  45      */
  46     const long IN               = 1;
  47
  48     /** indicates that the column stores INOUT parameters.
  49              A possible value for the column
  50              <code>COLUMN_TYPE</code>
  51              in the
  52              com::sun::star::sdbc::XResultSet
  53              returned by the method
  54              com::sun::star::sdbc::XDatabaseMetaData::getProcedureColumns().
  55      */
  56     const long INOUT            = 2;
  57
  58     /** indicates that the column stores results.
  59              A possible value for the column
  60              <code>COLUMN_TYPE</code>
  61              in the
  62              com::sun::star::sdbc::XResultSet
  63              returned by the method
  64              com::sun::star::sdbc::XDatabaseMetaData::getProcedureColumns().
  65      */
  66     const long RESULT           = 3;
  67
  68     /** indicates that the column stores OUT parameters.
  69              A possible value for the column
  70              <code>COLUMN_TYPE</code>
  71              in the
  72              com::sun::star::sdbc::XResultSet
  73              returned by the method
  74              com::sun::star::sdbc::XDatabaseMetaData::getProcedureColumns().
  75      */
  76     const long OUT              = 4;
  77
  78     /** Indicates that the column stores return values.
  79              A possible value for the column
  80              <code>COLUMN_TYPE</code>
  81              in the
  82              com::sun::star::sdbc::XResultSet
  83              returned by the method
  84              com::sun::star::sdbc::XDatabaseMetaData::getProcedureColumns().
  85      */
  86     const long RETURN           = 5;
  87 };
  88
  89
  90 }; }; }; };
  91
  92 /*===========================================================================
  93 ===========================================================================*/
  94
  95 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */