offapi/com/sun/star/sdb/DataColumn.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: DataColumn.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_DataColumn_idl__
  31 #define __com_sun_star_sdb_DataColumn_idl__
  32
  33 #ifndef __com_sun_star_sdb_ResultColumn_idl__
  34 #include <com/sun/star/sdb/ResultColumn.idl>
  35 #endif
  36
  37  module com {  module sun {  module star {  module sdb {
  38
  39  published interface XColumn;
  40  published interface XColumnUpdate;
  41
  42
  43 /** defines a column used for a result set which contains the data definition
  44     and the data of the column of the current row of a result set.
  45  */
  46 published service DataColumn
  47 {
  48     service com::sun::star::sdb::ResultColumn;
  49
  50
  51     /** is used to retrieve the columns value.
  52      */
  53     interface XColumn;
  54
  55
  56     /** is used to update the columns value.
  57      */
  58     interface XColumnUpdate;
  59
  60
  61     /** contains the column's value. This could be a constraint property, to
  62         veto modifications, if a new value does not fit into rules
  63         defined for the column.
  64      */
  65     [optional, property] any Value;
  66
  67
  68     /** contains the original value of the column.
  69      */
  70     [optional, readonly, property] any OriginalValue;
  71 };
  72
  73 //=============================================================================
  74
  75 }; }; }; };
  76
  77 /*===========================================================================
  78 ===========================================================================*/
  79 #endif