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