offapi/com/sun/star/chart2/data/XDataSink.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: XDataSink.idl,v $
  10  * $Revision: 1.3 $
  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_chart2_data_XDataSink_idl
  31 #define com_sun_star_chart2_data_XDataSink_idl
  32
  33 #include <com/sun/star/uno/XInterface.idl>
  34
  35 #include <com/sun/star/chart2/data/XLabeledDataSequence.idl>
  36
  37 module com
  38 {
  39 module sun
  40 {
  41 module star
  42 {
  43 module chart2
  44 {
  45 module data
  46 {
  47
  48 /** is a container for sequences of data.  With this interface data
  49     can only be written to.
  50
  51     <p>If you want to be able to also read the data set here, your
  52     component must also implement <type>XDataSource</type>.</p>
  53   */
  54 interface XDataSink : ::com::sun::star::uno::XInterface
  55 {
  56     /** sets new data sequences.  The elements set here must support
  57         the service <type>DataSequence</type>.
  58
  59         <p>If the data consist only of floating point numbers (double
  60         values), the instances set here should also support the
  61         service <type>NumericalDataSequence</type>.</p>
  62
  63         <p>If the data consist only of strings, the instances set here
  64         should also support the service
  65         <type>TextualDataSequence</type>.</p>
  66
  67         <p>If one of the derived services is supported by one element
  68         of the sequence, it should be available for all elements in
  69         the sequence.</p>
  70      */
  71     void  setData( [in] sequence< XLabeledDataSequence > aData );
  72 };
  73
  74 } ; // data
  75 } ; // chart2
  76 } ; // com
  77 } ; // sun
  78 } ; // star
  79
  80
  81 #endif