offapi/com/sun/star/ucb/XDataContainer.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: XDataContainer.idl,v $
  10  * $Revision: 1.9 $
  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_ucb_XDataContainer_idl__
  31 #define __com_sun_star_ucb_XDataContainer_idl__
  32
  33 #ifndef __com_sun_star_container_XIndexContainer_idl__
  34 #include <com/sun/star/container/XIndexContainer.idl>
  35 #endif
  36
  37
  38 //=============================================================================
  39
  40 module com { module sun { module star { module ucb {
  41
  42 //=============================================================================
  43 /** specifies a container for (binary) data.
  44
  45     <p>A data container may contain data and/or other data containers.
  46     A typical container with children is a MIME message with
  47     attachments.
  48
  49     @version    1.0
  50     @author     Kai Sommerfeld
  51
  52     @deprecated
  53 */
  54 published interface XDataContainer: com::sun::star::container::XIndexContainer
  55 {
  56     //-------------------------------------------------------------------------
  57     /** returns the content type (MIME Type) of the data container.
  58
  59         @returns
  60         the content type
  61     */
  62     string getContentType();
  63
  64     //-------------------------------------------------------------------------
  65     /** sets the content type (MIME Type) of the data container.
  66
  67         @param aType
  68         the content type
  69     */
  70     void setContentType( [in] string aType );
  71
  72     //-------------------------------------------------------------------------
  73     /** returns the data of the data container.
  74
  75         @returns
  76         the data
  77     */
  78     sequence<byte> getData();
  79
  80     //-------------------------------------------------------------------------
  81     /** sets the data of the data container.
  82
  83         @param aData
  84         the data
  85     */
  86     void setData( [in] sequence<byte> aData );
  87
  88     //-------------------------------------------------------------------------
  89     /** Deprecated. Do not use!
  90
  91         @deprecated
  92     */
  93     string getDataURL();
  94
  95     //-------------------------------------------------------------------------
  96     /** Deprecated. Do not use!
  97
  98         @deprecated
  99     */
 100     void setDataURL( [in] string aURL );
 101 };
 102
 103 //=============================================================================
 104
 105 }; }; }; };
 106
 107 #endif