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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28 #ifndef __com_sun_star_sdbcx_ColumnDescriptor_idl__
  29 #define __com_sun_star_sdbcx_ColumnDescriptor_idl__
  30
  31 #include <com/sun/star/sdbcx/Descriptor.idl>
  32
  33  module com {  module sun {  module star {  module sdbcx {
  34
  35
  36 /** describes the common properties of a database column. Could be used for the creation
  37     of a database columns within a table.
  38     @see com::sun::star::sdbcx::Column
  39     @see com::sun::star::sdbcx::Table
  40  */
  41 published service ColumnDescriptor
  42 {
  43     service com::sun::star::sdbcx::Descriptor;
  44
  45
  46     /** is the
  47         <type scope="com::sun::star::sdbc">DataType</type>
  48         of the column.
  49      */
  50     [property] long Type;
  51
  52
  53     /** is the type name used by the database. If the column type is
  54         a user-defined type, then a fully-qualified type name is returned.
  55         May be empty.
  56      */
  57     [property] string TypeName;
  58
  59
  60     /** gets a column's number of decimal digits.
  61      */
  62     [property] long Precision;
  63
  64
  65     /** gets a column's number of digits to right of the decimal point.
  66      */
  67     [property] long Scale;
  68
  69
  70     /** indicates the nullability of values in the designated column.
  71         @see com::sun::star::sdbc::ColumnValue
  72      */
  73     [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     [property] boolean IsAutoIncrement;
  80
  81
  82     /** indicates that the column contains some kind of time or date stamp
  83         used to track updates.
  84      */
  85     [optional, property] boolean IsRowVersion;
  86
  87
  88     /** keeps a description of the object.
  89      */
  90     [optional, property] string Description;
  91
  92
  93     /** keeps a default value for a column, is provided as string.
  94      */
  95     [optional, property] string DefaultValue;
  96
  97     /** specifies how to create an auto-increment column.
  98      */
  99     [optional, property] string AutoIncrementCreation;
 100 };
 101
 102 //=============================================================================
 103
 104 }; }; }; };
 105
 106 #endif
 107
 108 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */