offapi/com/sun/star/sdbcx/Column.idl

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