xref: /aoo4110/main/offapi/com/sun/star/sdbcx/Column.idl (revision b1cdbd2c) 
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_sdbcx_Column_idl__
24#define __com_sun_star_sdbcx_Column_idl__
25
26#ifndef __com_sun_star_beans_XPropertySet_idl__
27#include <com/sun/star/beans/XPropertySet.idl>
28#endif
29
30 module com {  module sun {  module star {  module sdbcx {
31
32 published interface XDataDescriptorFactory;
33
34
35/** describes the common properties of a database column.
36 */
37published service Column
38{
39
40	/** optional, could be used to copy a database column.
41	 */
42	[optional] interface XDataDescriptorFactory;
43
44	// gives access to the properties.
45	interface com::sun::star::beans::XPropertySet;
46
47
48	/** is the name of the column.
49	 */
50	[readonly, property] string Name;
51
52
53	/** is the
54		<type scope="com::sun::star::sdbc">DataType</type>
55		of the column.
56	 */
57	[readonly, property] long Type;
58
59
60	/** is the type name used by the database. If the column type is
61		a user-defined type, then a fully-qualified type name is returned.
62		<b>
63		Note:
64		</b>
65		May be empty.
66	 */
67	[readonly, property] string TypeName;
68
69
70	/** gets a column's number of decimal digits.
71	 */
72	[readonly, property] long Precision;
73
74
75	/** gets a column's number of digits to right of the decimal point.
76	 */
77	[readonly, property] long Scale;
78
79
80	/** indicates the nullability of values in the designated column.
81		@see com::sun::star::sdbc::ColumnValue
82	 */
83	[readonly, property] long IsNullable;
84
85
86	/** indicates whether the column is automatically numbered, thus read-only.
87		@see com::sun::star::sdbc::ColumnValue
88	 */
89	[readonly, property] boolean IsAutoIncrement;
90
91
92	/** indicates whether the column is a cash value.
93	 */
94	[readonly, property] boolean IsCurrency;
95
96
97
98	/** indicates that the column contains some kind of time or date stamp
99		used to track updates.
100	 */
101	[optional, readonly, property] boolean IsRowVersion;
102
103
104	/** keeps a description of the object.
105	 */
106	[optional, readonly, property] string Description;
107
108
109	/** keeps a default value for a column, is provided as string.
110	 */
111	[optional, readonly, property] string DefaultValue;
112
113};
114
115//=============================================================================
116
117}; }; }; };
118
119/*===========================================================================
120===========================================================================*/
121#endif
122