offapi/com/sun/star/sdb/ResultColumn.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_sdb_ResultColumn_idl__
  28 #define __com_sun_star_sdb_ResultColumn_idl__
  29
  30 #ifndef __com_sun_star_sdbcx_Column_idl__
  31 #include <com/sun/star/sdbcx/Column.idl>
  32 #endif
  33
  34 #ifndef __com_sun_star_sdb_ColumnSettings_idl__
  35 #include <com/sun/star/sdb/ColumnSettings.idl>
  36 #endif
  37
  38  module com {  module sun {  module star {  module sdb {
  39
  40
  41 /** describes a column of a result set.
  42  */
  43 published service ResultColumn
  44 {
  45     service com::sun::star::sdbcx::Column;
  46
  47
  48     /** [optional], access to layout settings for a column.
  49      */
  50     service com::sun::star::sdb::ColumnSettings;
  51
  52
  53     /** indicates whether the column can be used in a Where clause.
  54      */
  55     [readonly, property] boolean IsSearchable;
  56
  57
  58     /** indicates whether values in the column are signed numbers.
  59      */
  60     [readonly, property] boolean IsSigned;
  61
  62
  63     /** indicates that a column is case sensitive.
  64      */
  65     [readonly, property] boolean IsCaseSensitive;
  66
  67
  68     /** indicates the column's normal max width in chars..
  69      */
  70     [readonly, property] long DisplaySize;
  71
  72
  73     /** gets the suggested column title for use in printouts and
  74         displays.
  75      */
  76     [readonly, property] string Label;
  77
  78
  79     /** indicates whether a column is definitely, not writable.
  80      */
  81     [readonly, property] boolean IsReadOnly;
  82
  83
  84     /** indicates whether it is possible for a write on the column to succeed.
  85      */
  86     [readonly, property] boolean IsWritable;
  87
  88
  89     /** indicates whether a write on the column will definitely succeed.
  90      */
  91     [readonly, property] boolean IsDefinitelyWritable;
  92
  93
  94     /** returns the fully-qualified name of the service whose instances
  95         are manufactured if the method
  96         <method scope="com::sun::star::sdbc">XRow::getObject)=</method>
  97         is called to retrieve a value from the column.
  98      */
  99     [readonly, property] string ServiceName;
 100
 101
 102     /** gets a column's table name.
 103      */
 104     [readonly, property] string TableName;
 105
 106
 107     /** gets a column's schema name.
 108      */
 109     [readonly, property] string SchemaName;
 110
 111
 112     /** gets a column's table's catalog name.
 113      */
 114     [readonly, property] string CatalogName;
 115 };
 116
 117 //=============================================================================
 118
 119 }; }; }; };
 120
 121 /*===========================================================================
 122 ===========================================================================*/
 123 #endif