offapi/com/sun/star/sdb/ResultColumn.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: ResultColumn.idl,v $
  10  * $Revision: 1.10 $
  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_sdb_ResultColumn_idl__
  31 #define __com_sun_star_sdb_ResultColumn_idl__
  32
  33 #ifndef __com_sun_star_sdbcx_Column_idl__
  34 #include <com/sun/star/sdbcx/Column.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_sdb_ColumnSettings_idl__
  38 #include <com/sun/star/sdb/ColumnSettings.idl>
  39 #endif
  40
  41  module com {  module sun {  module star {  module sdb {
  42
  43
  44 /** describes a column of a result set.
  45  */
  46 published service ResultColumn
  47 {
  48     service com::sun::star::sdbcx::Column;
  49
  50
  51     /** [optional], access to layout settings for a column.
  52      */
  53     service com::sun::star::sdb::ColumnSettings;
  54
  55
  56     /** indicates whether the column can be used in a Where clause.
  57      */
  58     [readonly, property] boolean IsSearchable;
  59
  60
  61     /** indicates whether values in the column are signed numbers.
  62      */
  63     [readonly, property] boolean IsSigned;
  64
  65
  66     /** indicates that a column is case sensitive.
  67      */
  68     [readonly, property] boolean IsCaseSensitive;
  69
  70
  71     /** indicates the column's normal max width in chars..
  72      */
  73     [readonly, property] long DisplaySize;
  74
  75
  76     /** gets the suggested column title for use in printouts and
  77         displays.
  78      */
  79     [readonly, property] string Label;
  80
  81
  82     /** indicates whether a column is definitely, not writable.
  83      */
  84     [readonly, property] boolean IsReadOnly;
  85
  86
  87     /** indicates whether it is possible for a write on the column to succeed.
  88      */
  89     [readonly, property] boolean IsWritable;
  90
  91
  92     /** indicates whether a write on the column will definitely succeed.
  93      */
  94     [readonly, property] boolean IsDefinitelyWritable;
  95
  96
  97     /** returns the fully-qualified name of the service whose instances
  98         are manufactured if the method
  99         <method scope="com::sun::star::sdbc">XRow::getObject)=</method>
 100         is called to retrieve a value from the column.
 101      */
 102     [readonly, property] string ServiceName;
 103
 104
 105     /** gets a column's table name.
 106      */
 107     [readonly, property] string TableName;
 108
 109
 110     /** gets a column's schema name.
 111      */
 112     [readonly, property] string SchemaName;
 113
 114
 115     /** gets a column's table's catalog name.
 116      */
 117     [readonly, property] string CatalogName;
 118 };
 119
 120 //=============================================================================
 121
 122 }; }; }; };
 123
 124 /*===========================================================================
 125 ===========================================================================*/
 126 #endif