xref: /AOO41X/main/offapi/com/sun/star/sdbc/ProcedureColumn.idl (revision d1766043198e81d0bcfc626e12893e7b4d7e31ca)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_sdbc_ProcedureColumn_idl__
24#define __com_sun_star_sdbc_ProcedureColumn_idl__
25
26 module com {  module sun {  module star {  module sdbc {
27
28
29/** indicates the type of a procedure column.
30 */
31published constants ProcedureColumn
32{
33
34    /** indicates that the type of the column is unknown. A possible value for
35             the column
36             <code>COLUMN_TYPE</code>
37             in the
38             <type scope="com::sun::star::sdbc">XResultSet</type>
39             returned by the method
40             <member scope="com::sun::star::sdbc">XDatabaseMetaData::getProcedureColumns()</member>
41             .
42     */
43    const long UNKNOWN          = 0;
44    //-------------------------------------------------------------------------
45
46    /** indicates that the column stores IN parameters.
47             A possible value for the column
48             <code>COLUMN_TYPE</code>
49             in the
50             <type scope="com::sun::star::sdbc">XResultSet</type>
51             returned by the method
52             <member scope="com::sun::star::sdbc">XDatabaseMetaData::getProcedureColumns()</member>
53             .
54     */
55    const long IN               = 1;
56    //-------------------------------------------------------------------------
57
58    /** indicates that the column stores INOUT parameters.
59             A possible value for the column
60             <code>COLUMN_TYPE</code>
61             in the
62             <type scope="com::sun::star::sdbc">XResultSet</type>
63             returned by the method
64             <member scope="com::sun::star::sdbc">XDatabaseMetaData::getProcedureColumns()</member>
65             .
66     */
67    const long INOUT            = 2;
68    //-------------------------------------------------------------------------
69
70    /** indicates that the column stores results.
71             A possible value for the column
72             <code>COLUMN_TYPE</code>
73             in the
74             <type scope="com::sun::star::sdbc">XResultSet</type>
75             returned by the method
76             <member scope="com::sun::star::sdbc">XDatabaseMetaData::getProcedureColumns()</member>
77             .
78     */
79    const long RESULT           = 3;
80    //-------------------------------------------------------------------------
81
82    /** indicates that the column stores OUT parameters.
83             A possible value for the column
84             <code>COLUMN_TYPE</code>
85             in the
86             <type scope="com::sun::star::sdbc">XResultSet</type>
87             returned by the method
88             <member scope="com::sun::star::sdbc">XDatabaseMetaData::getProcedureColumns()</member>
89             .
90     */
91    const long OUT              = 4;
92    //-------------------------------------------------------------------------
93
94    /** Indicates that the column stores return values.
95             A possible value for the column
96             <code>COLUMN_TYPE</code>
97             in the
98             <type scope="com::sun::star::sdbc">XResultSet</type>
99             returned by the method
100             <member scope="com::sun::star::sdbc">XDatabaseMetaData::getProcedureColumns()</member>
101             .
102     */
103    const long RETURN           = 5;
104};
105
106//=============================================================================
107
108}; }; }; };
109
110/*===========================================================================
111===========================================================================*/
112#endif
113