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