office-gobmx/offapi/com/sun/star/sdb/ResultColumn.idl

/*************************************************************************
 *
 *  $RCSfile: ResultColumn.idl,v $
 *
 *  $Revision: 1.6 $
 *
 *  last change: $Author: hr $ $Date: 2003-03-26 13:55:02 $
 *
 *  The Contents of this file are made available subject to the terms of
 *  either of the following licenses
 *
 *         - GNU Lesser General Public License Version 2.1
 *         - Sun Industry Standards Source License Version 1.1
 *
 *  Sun Microsystems Inc., October, 2000
 *
 *  GNU Lesser General Public License Version 2.1
 *  =============================================
 *  Copyright 2000 by Sun Microsystems, Inc.
 *  901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License version 2.1, as published by the Free Software Foundation.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *  MA  02111-1307  USA
 *
 *
 *  Sun Industry Standards Source License Version 1.1
 *  =================================================
 *  The contents of this file are subject to the Sun Industry Standards
 *  Source License Version 1.1 (the "License"); You may not use this file
 *  except in compliance with the License. You may obtain a copy of the
 *  License at http://www.openoffice.org/license.html.
 *
 *  Software provided under this License is provided on an "AS IS" basis,
 *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
 *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
 *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
 *  See the License for the specific provisions governing your rights and
 *  obligations concerning the Software.
 *
 *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
 *
 *  Copyright: 2000 by Sun Microsystems, Inc.
 *
 *  All Rights Reserved.
 *
 *  Contributor(s): _______________________________________
 *
 *
 ************************************************************************/
#ifndef __com_sun_star_sdb_ResultColumn_idl__
#define __com_sun_star_sdb_ResultColumn_idl__

#ifndef __com_sun_star_sdbcx_Column_idl__
#include <com/sun/star/sdbcx/Column.idl>
#endif

#ifndef __com_sun_star_sdb_ColumnSettings_idl__
#include <com/sun/star/sdb/ColumnSettings.idl>
#endif

 module com {  module sun {  module star {  module sdb {


// DocMerge from xml: service com::sun::star::sdb::ResultColumn
/** describes a column of a result set.
 */
service ResultColumn
{
    // DocMerge: empty anyway
    service com::sun::star::sdbcx::Column;


    // DocMerge from xml: service com::sun::star::sdb::ResultColumn: service com::sun::star::sdb::ColumnSettings
    /** [optional], access to layout settings for a column.
     */
    service com::sun::star::sdb::ColumnSettings;


    // DocMerge from xml: property com::sun::star::sdb::ResultColumn::IsSearchable
    /** indicates whether the column can be used in a Where clause.
     */
    [readonly, property] boolean IsSearchable;


    // DocMerge from xml: property com::sun::star::sdb::ResultColumn::IsSigned
    /** indicates whether values in the column are signed numbers.
     */
    [readonly, property] boolean IsSigned;


    // DocMerge from xml: property com::sun::star::sdb::ResultColumn::IsCaseSensitive
    /** indicates that a column is case sensitive.
     */
    [readonly, property] boolean IsCaseSensitive;


    // DocMerge from xml: property com::sun::star::sdb::ResultColumn::DisplaySize
    /** indicates the column's normal max width in chars..
     */
    [readonly, property] long DisplaySize;


    // DocMerge from xml: property com::sun::star::sdb::ResultColumn::Label
    /** gets the suggested column title for use in printouts and
        displays.
     */
    [readonly, property] string Label;


    // DocMerge from xml: property com::sun::star::sdb::ResultColumn::IsReadOnly
    /** indicates whether a column is definitely, not writable.
     */
    [readonly, property] boolean IsReadOnly;


    // DocMerge from xml: property com::sun::star::sdb::ResultColumn::IsWritable
    /** indicates whether it is possible for a write on the column to succeed.
     */
    [readonly, property] boolean IsWritable;


    // DocMerge from xml: property com::sun::star::sdb::ResultColumn::IsDefinitelyWritable
    /** indicates whether a write on the column will definitely succeed.
     */
    [readonly, property] boolean IsDefinitelyWritable;


    // DocMerge from xml: property com::sun::star::sdb::ResultColumn::ServiceName
    /** returns the fully-qualified name of the service whose instances
        are manufactured if the method
        <method scope="com::sun::star::sdbc">XRow::getObject)=</method>
        is called to retrieve a value from the column.
     */
    [readonly, property] string ServiceName;


    // DocMerge from xml: property com::sun::star::sdb::ResultColumn::TableName
    /** gets a column's table name.
     */
    [readonly, property] string TableName;


    // DocMerge from xml: property com::sun::star::sdb::ResultColumn::SchemaName
    /** gets a column's schema name.
     */
    [readonly, property] string SchemaName;


    // DocMerge from xml: property com::sun::star::sdb::ResultColumn::CatalogName
    /** gets a column's table's catalog name.
     */
    [readonly, property] string CatalogName;
};

//=============================================================================

}; }; }; };

/*===========================================================================
===========================================================================*/
#endif