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