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