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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: Column.idl,v $
  10  * $Revision: 1.11 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_sdbcx_Column_idl__
  31 #define __com_sun_star_sdbcx_Column_idl__
  32
  33 #ifndef __com_sun_star_beans_XPropertySet_idl__
  34 #include <com/sun/star/beans/XPropertySet.idl>
  35 #endif
  36
  37  module com {  module sun {  module star {  module sdbcx {
  38
  39  published interface XDataDescriptorFactory;
  40
  41
  42 /** describes the common properties of a database column.
  43  */
  44 published service Column
  45 {
  46
  47     /** optional, could be used to copy a database column.
  48      */
  49     [optional] interface XDataDescriptorFactory;
  50
  51     // gives access to the properties.
  52     interface com::sun::star::beans::XPropertySet;
  53
  54
  55     /** is the name of the column.
  56      */
  57     [readonly, property] string Name;
  58
  59
  60     /** is the
  61         <type scope="com::sun::star::sdbc">DataType</type>
  62         of the column.
  63      */
  64     [readonly, property] long Type;
  65
  66
  67     /** is the type name used by the database. If the column type is
  68         a user-defined type, then a fully-qualified type name is returned.
  69         <b>
  70         Note:
  71         </b>
  72         May be empty.
  73      */
  74     [readonly, property] string TypeName;
  75
  76
  77     /** gets a column's number of decimal digits.
  78      */
  79     [readonly, property] long Precision;
  80
  81
  82     /** gets a column's number of digits to right of the decimal point.
  83      */
  84     [readonly, property] long Scale;
  85
  86
  87     /** indicates the nullability of values in the designated column.
  88         @see com::sun::star::sdbc::ColumnValue
  89      */
  90     [readonly, property] long IsNullable;
  91
  92
  93     /** indicates whether the column is automatically numbered, thus read-only.
  94         @see com::sun::star::sdbc::ColumnValue
  95      */
  96     [readonly, property] boolean IsAutoIncrement;
  97
  98
  99     /** indicates whether the column is a cash value.
 100      */
 101     [readonly, property] boolean IsCurrency;
 102
 103
 104
 105     /** indicates that the column contains some kind of time or date stamp
 106         used to track updates.
 107      */
 108     [optional, readonly, property] boolean IsRowVersion;
 109
 110
 111     /** keeps a description of the object.
 112      */
 113     [optional, readonly, property] string Description;
 114
 115
 116     /** keeps a default value for a column, is provided as string.
 117      */
 118     [optional, readonly, property] string DefaultValue;
 119
 120 };
 121
 122 //=============================================================================
 123
 124 }; }; }; };
 125
 126 /*===========================================================================
 127 ===========================================================================*/
 128 #endif