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