summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/sdbcx/Column.idl
blob: adb7abf034e621c272c456f17e0d3ed752bb2a0a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 * 
 * Copyright 2008 by Sun Microsystems, Inc.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * $RCSfile: Column.idl,v $
 * $Revision: 1.11 $
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org 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 version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_sdbcx_Column_idl__ 
#define __com_sun_star_sdbcx_Column_idl__ 
 
#ifndef __com_sun_star_beans_XPropertySet_idl__ 
#include <com/sun/star/beans/XPropertySet.idl> 
#endif 
 
 module com {  module sun {  module star {  module sdbcx { 
 
 published interface XDataDescriptorFactory; 
 
 
/** describes the common properties of a database column.
 */
published service Column
{ 
     
    /** optional, could be used to copy a database column.
     */
    [optional] interface XDataDescriptorFactory; 
 
    // gives access to the properties.
    interface com::sun::star::beans::XPropertySet; 
 
     
    /** is the name of the column.
     */
    [readonly, property] string Name; 
 
     
    /** is the 
        <type scope="com::sun::star::sdbc">DataType</type>
        of the column.
     */
    [readonly, property] long Type; 
 
     
    /** is the type name used by the database. If the column type is
        a user-defined type, then a fully-qualified type name is returned.
        <b>
        Note:
        </b>
        May be empty.
     */
    [readonly, property] string TypeName; 
 
     
    /** gets a column's number of decimal digits.
     */
    [readonly, property] long Precision; 
 
     
    /** gets a column's number of digits to right of the decimal point.
     */
    [readonly, property] long Scale; 
 
     
    /** indicates the nullability of values in the designated column.
        @see com::sun::star::sdbc::ColumnValue
     */
    [readonly, property] long IsNullable; 
 
     
    /** indicates whether the column is automatically numbered, thus read-only.
        @see com::sun::star::sdbc::ColumnValue
     */
    [readonly, property] boolean IsAutoIncrement; 
 
     
    /** indicates whether the column is a cash value.
     */
    [readonly, property] boolean IsCurrency; 
 
     
 
    /** indicates that the column contains some kind of time or date stamp
        used to track updates. 
     */
    [optional, readonly, property] boolean IsRowVersion; 
 
     
    /** keeps a description of the object.
     */
    [optional, readonly, property] string Description; 
 
     
    /** keeps a default value for a column, is provided as string.
     */
    [optional, readonly, property] string DefaultValue; 
 
}; 
 
//============================================================================= 
 
}; }; }; }; 
 
/*=========================================================================== 
===========================================================================*/ 
#endif