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_ColumnDescriptor_idl__
24#define __com_sun_star_sdbcx_ColumnDescriptor_idl__
25
26#ifndef __com_sun_star_sdbcx_Descriptor_idl__
27#include <com/sun/star/sdbcx/Descriptor.idl>
28#endif
29
30 module com {  module sun {  module star {  module sdbcx {
31
32
33/** describes the common properties of a database column. Could be used for the creation
34	of a database columns within a table.
35	@see com::sun::star::sdbcx::Column
36	@see com::sun::star::sdbcx::Table
37 */
38published service ColumnDescriptor
39{
40	service com::sun::star::sdbcx::Descriptor;
41
42
43	/** is the
44		<type scope="com::sun::star::sdbc">DataType</type>
45		of the column.
46	 */
47	[property] long Type;
48
49
50	/** is the type name used by the database. If the column type is
51		a user-defined type, then a fully-qualified type name is returned.
52		May be empty.
53	 */
54	[property] string TypeName;
55
56
57	/** gets a column's number of decimal digits.
58	 */
59	[property] long Precision;
60
61
62	/** gets a column's number of digits to right of the decimal point.
63	 */
64	[property] long Scale;
65
66
67	/** indicates the nullability of values in the designated column.
68		@see com::sun::star::sdbc::ColumnValue
69	 */
70	[property] long IsNullable;
71
72
73	/** indicates whether the column is automatically numbered, thus read-only.
74		@see com::sun::star::sdbc::ColumnValue
75	 */
76	[property] boolean IsAutoIncrement;
77
78
79	/** indicates that the column contains some kind of time or date stamp
80		used to track updates.
81	 */
82	[optional, property] boolean IsRowVersion;
83
84
85	/** keeps a description of the object.
86	 */
87	[optional, property] string Description;
88
89
90	/** keeps a default value for a column, is provided as string.
91	 */
92	[optional, property] string DefaultValue;
93
94	/** specifies how to create an autoincrement column.
95	 */
96	[optional, property] string AutoIncrementCreation;
97};
98
99//=============================================================================
100
101}; }; }; };
102
103#endif
104