offapi/com/sun/star/ucb/PackageStreamContent.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: PackageStreamContent.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_ucb_PackageStreamContent_idl__
  31 #define __com_sun_star_ucb_PackageStreamContent_idl__
  32
  33 #ifndef __com_sun_star_lang_XComponent_idl__
  34 #include <com/sun/star/lang/XComponent.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_ucb_XContent_idl__
  38 #include <com/sun/star/ucb/XContent.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_ucb_XCommandProcessor_idl__
  42 #include <com/sun/star/ucb/XCommandProcessor.idl>
  43 #endif
  44
  45 #ifndef __com_sun_star_ucb_XCommandProcessor2_idl__
  46 #include <com/sun/star/ucb/XCommandProcessor2.idl>
  47 #endif
  48
  49 #ifndef __com_sun_star_beans_XPropertiesChangeNotifier_idl__
  50 #include <com/sun/star/beans/XPropertiesChangeNotifier.idl>
  51 #endif
  52
  53 #ifndef __com_sun_star_beans_XPropertyContainer_idl__
  54 #include <com/sun/star/beans/XPropertyContainer.idl>
  55 #endif
  56
  57 #ifndef __com_sun_star_beans_XPropertySetInfoChangeNotifier_idl__
  58 #include <com/sun/star/beans/XPropertySetInfoChangeNotifier.idl>
  59 #endif
  60
  61 #ifndef __com_sun_star_ucb_XCommandInfoChangeNotifier_idl__
  62 #include <com/sun/star/ucb/XCommandInfoChangeNotifier.idl>
  63 #endif
  64
  65 #ifndef __com_sun_star_container_XChild_idl__
  66 #include <com/sun/star/container/XChild.idl>
  67 #endif
  68
  69 //=============================================================================
  70
  71 module com { module sun { module star { module ucb {
  72
  73 //=============================================================================
  74 /** A PCP Stream is a content which represents a file inside a package.
  75
  76     <p>It is always contained in a PCP Folder. A PCP Stream has no children.
  77
  78     @see com::sun::star::ucb::PackageContentProvider
  79     @see com::sun::star::ucb::PackageFolderContent
  80 */
  81 published service PackageStreamContent
  82 {
  83     //-------------------------------------------------------------------------
  84     /** This interface is implemented according to the specification of
  85         service <type>Content</type>.
  86      */
  87     interface com::sun::star::lang::XComponent;
  88
  89     //-------------------------------------------------------------------------
  90     /** This interface is implemented according to the specification of
  91         service <type>Content</type>.
  92      */
  93     interface com::sun::star::ucb::XContent;
  94
  95     //-------------------------------------------------------------------------
  96     /** This interface is implemented according to the specification of
  97         service <type>Content</type>.
  98
  99         <p>
 100
 101         <b>Supported Commands</b>
 102         <ul>
 103         <li>
 104         getCommandInfo
 105         </li>
 106         <li>
 107         getPropertySetInfo
 108         </li>
 109         <li>
 110         getPropertyValues
 111         </li>
 112         <li>
 113         setPropertyValues
 114         </li>
 115         <li>
 116         insert ( makes a newly created stream persistent )
 117         </li>
 118         <li>
 119         delete
 120         </li>
 121         <li>
 122         open
 123         </li>
 124         </ul>
 125
 126         <b>Supported Properties</b>
 127         <ul>
 128         <li>
 129         string ContentType ( read-only, always "application/vnd.sun.star.pkg-stream" )
 130         </li>
 131         <li>
 132         boolean IsDocument ( read-only, always true )
 133         </li>
 134         <li>
 135         boolean IsFolder ( read-only, always false )
 136         </li>
 137         <li>
 138         string MediaType
 139         </li>
 140         <li>
 141         string Size ( read-only )
 142         </li>
 143         <li>
 144         string Title
 145         </li>
 146         <li>
 147         boolean Compressed ( allows you to explecitly state whether you want a
 148         stream to be compressed or not. The default value of this property
 149         will be determined according to the value of the property 'MediaType'.
 150         If it is empty or prefixed by "text/", the value of 'Compressed' is set
 151         to true. Otherwise the value will be false. )
 152         </li>
 153         <li>
 154         boolean Encrypted ( are the stream data encrypted or not ).
 155         </li>
 156         </ul>
 157
 158         </p>
 159      */
 160     interface com::sun::star::ucb::XCommandProcessor;
 161
 162     //-------------------------------------------------------------------------
 163     /** is an enhanced version of <type>XCommandProcessor</type> that has an
 164         additional method for releasing command identifiers obtained via
 165         <member>XCommandProcessor::createCommandIdentifier</member> to avoid
 166         resource leaks. For a detailed description of the problem refer to
 167         <member>XCommandProcessor2::releaseCommandIdentifier</member>.
 168
 169         <p>Where many existing <type>Content</type> implementations do not
 170         (yet), every new implementation should support this interface.
 171      */
 172     [optional] interface com::sun::star::ucb::XCommandProcessor2;
 173
 174     //-------------------------------------------------------------------------
 175     /** This interface is implemented according to the specification of
 176         service <type>Content</type>.
 177      */
 178     interface com::sun::star::beans::XPropertiesChangeNotifier;
 179
 180     //-------------------------------------------------------------------------
 181     /** This interface is implemented according to the specification of
 182         service <type>Content</type>.
 183      */
 184     interface com::sun::star::beans::XPropertyContainer;
 185
 186     //-------------------------------------------------------------------------
 187     /** This interface is implemented according to the specification of
 188         service <type>Content</type>.
 189      */
 190     interface com::sun::star::beans::XPropertySetInfoChangeNotifier;
 191
 192     //-------------------------------------------------------------------------
 193     /** This interface is implemented according to the specification of
 194         service <type>Content</type>.
 195      */
 196     interface com::sun::star::ucb::XCommandInfoChangeNotifier;
 197
 198     //-------------------------------------------------------------------------
 199     /** This interface is implemented according to the specification of
 200         service <type>Content</type>.
 201      */
 202     interface com::sun::star::container::XChild;
 203 };
 204
 205 //=============================================================================
 206
 207 }; }; }; };
 208
 209 #endif