LibreOffice
LibreOffice 24.2 SDK API Reference
Column.idl
Go to the documentation of this file.
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 /*
3  * This file is part of the LibreOffice project.
4  *
5  * This Source Code Form is subject to the terms of the Mozilla Public
6  * License, v. 2.0. If a copy of the MPL was not distributed with this
7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8  *
9  * This file incorporates work covered by the following license notice:
10  *
11  * Licensed to the Apache Software Foundation (ASF) under one or more
12  * contributor license agreements. See the NOTICE file distributed
13  * with this work for additional information regarding copyright
14  * ownership. The ASF licenses this file to you under the Apache
15  * License, Version 2.0 (the "License"); you may not use this file
16  * except in compliance with the License. You may obtain a copy of
17  * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18  */
19 
20  module com { module sun { module star { module sdbcx {
21 
22  published interface XDataDescriptorFactory;
23 
24 
27 published service Column
28 {
29 
32  [optional] interface XDataDescriptorFactory;
33 
34  // gives access to the properties.
36 
37 
40  [readonly, property] string Name;
41 
42 
47  [readonly, property] long Type;
48 
49 
57  [readonly, property] string TypeName;
58 
59 
62  [readonly, property] long Precision;
63 
64 
67  [readonly, property] long Scale;
68 
69 
73  [readonly, property] long IsNullable;
74 
75 
79  [readonly, property] boolean IsAutoIncrement;
80 
81 
84  [readonly, property] boolean IsCurrency;
85 
86 
87 
91  [optional, readonly, property] boolean IsRowVersion;
92 
93 
96  [optional, readonly, property] string Description;
97 
98 
101  [optional, readonly, property] string DefaultValue;
102 
103 };
104 
105 
106 }; }; }; };
107 
108 /*===========================================================================
109 ===========================================================================*/
110 
111 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
long Scale
gets a column's number of digits to right of the decimal point.
Definition: Column.idl:67
string DefaultValue
keeps a default value for a column, is provided as string.
Definition: Column.idl:101
long Precision
gets a column's number of decimal digits.
Definition: Column.idl:62
Definition: Ambiguous.idl:20
describes the common properties of a database column.
Definition: Column.idl:27
boolean IsAutoIncrement
indicates whether the column is automatically numbered, thus read-only.
Definition: Column.idl:79
provides the creation of a descriptor for a definition object.
Definition: XDataDescriptorFactory.idl:28
boolean IsCurrency
indicates whether the column is a cash value.
Definition: Column.idl:84
long Type
is the com::sun::star::sdbc::DataType of the column.
Definition: Column.idl:47
string Name
is the name of the column.
Definition: Column.idl:35
boolean IsRowVersion
indicates that the column contains some kind of time or date stamp used to track updates.
Definition: Column.idl:91
long IsNullable
indicates the nullability of values in the designated column.
Definition: Column.idl:73
string Description
keeps a description of the object.
Definition: Column.idl:96
provides information about and access to the properties from an implementation.
Definition: XPropertySet.idl:45
string TypeName
is the type name used by the database.
Definition: Column.idl:57