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