LibreOffice LibreOffice 7.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#ifndef __com_sun_star_sdbcx_Column_idl__
20#define __com_sun_star_sdbcx_Column_idl__
21
22#include <com/sun/star/beans/XPropertySet.idl>
23
24 module com { module sun { module star { module sdbcx {
25
26 published interface XDataDescriptorFactory;
27
28
31published service Column
32{
33
36 [optional] interface XDataDescriptorFactory;
37
38 // gives access to the properties.
39 interface com::sun::star::beans::XPropertySet;
40
41
44 [readonly, property] string Name;
45
46
51 [readonly, property] long Type;
52
53
61 [readonly, property] string TypeName;
62
63
66 [readonly, property] long Precision;
67
68
71 [readonly, property] long Scale;
72
73
77 [readonly, property] long IsNullable;
78
79
83 [readonly, property] boolean IsAutoIncrement;
84
85
88 [readonly, property] boolean IsCurrency;
89
90
91
95 [optional, readonly, property] boolean IsRowVersion;
96
97
100 [optional, readonly, property] string Description;
101
102
105 [optional, readonly, property] string DefaultValue;
106
107};
108
109
110}; }; }; };
111
112/*===========================================================================
113===========================================================================*/
114#endif
115
116/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
XPropertySet.idl
com::sun::star::beans::XPropertySet
provides information about and access to the properties from an implementation.
Definition: XPropertySet.idl:64
com::sun::star::sdbcx::XDataDescriptorFactory
provides the creation of a descriptor for a definition object.
Definition: XDataDescriptorFactory.idl:33
com
Definition: Accessible.idl:22
com::sun::star::sdbcx::Column
describes the common properties of a database column.
Definition: Column.idl:32
com::sun::star::sdbcx::Column::Type
long Type
is the com::sun::star::sdbc::DataType of the column.
Definition: Column.idl:51
com::sun::star::sdbcx::Column::Precision
long Precision
gets a column's number of decimal digits.
Definition: Column.idl:66
com::sun::star::sdbcx::Column::Description
string Description
keeps a description of the object.
Definition: Column.idl:100
com::sun::star::sdbcx::Column::TypeName
string TypeName
is the type name used by the database.
Definition: Column.idl:61
com::sun::star::sdbcx::Column::Scale
long Scale
gets a column's number of digits to right of the decimal point.
Definition: Column.idl:71
com::sun::star::sdbcx::Column::IsAutoIncrement
boolean IsAutoIncrement
indicates whether the column is automatically numbered, thus read-only.
Definition: Column.idl:83
com::sun::star::sdbcx::Column::DefaultValue
string DefaultValue
keeps a default value for a column, is provided as string.
Definition: Column.idl:105
com::sun::star::sdbcx::Column::Name
string Name
is the name of the column.
Definition: Column.idl:39
com::sun::star::sdbcx::Column::IsRowVersion
boolean IsRowVersion
indicates that the column contains some kind of time or date stamp used to track updates.
Definition: Column.idl:95
com::sun::star::sdbcx::Column::IsNullable
long IsNullable
indicates the nullability of values in the designated column.
Definition: Column.idl:77
com::sun::star::sdbcx::Column::IsCurrency
boolean IsCurrency
indicates whether the column is a cash value.
Definition: Column.idl:88