offapi/com/sun/star/ucb/TransientDocumentsDocumentContent.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: TransientDocumentsDocumentContent.idl,v $
  10  * $Revision: 1.5 $
  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_TransientDocumentsDocumentContent_idl__
  31 #define __com_sun_star_ucb_TransientDocumentsDocumentContent_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 #ifndef __com_sun_star_ucb_XContentCreator_idl__
  70 #include <com/sun/star/ucb/XContentCreator.idl>
  71 #endif
  72
  73 //=============================================================================
  74
  75 module com { module sun { module star { module ucb {
  76
  77 //=============================================================================
  78 /** A TDCP Document represents the root folder of a transient document.
  79
  80     <p>It is a container for other TDCP Folders and TDCP Streams. It is always
  81     a child of the TDCP Root.
  82
  83     @see TransientDocumentsContentProvider
  84     @see TransientDocumentsRootContent
  85     @see TransientDocumentsFolderContent
  86     @see TransientDocumentsStreamContent
  87
  88     @since OOo 2.0.0
  89 */
  90 service TransientDocumentsDocumentContent
  91 {
  92     //-------------------------------------------------------------------------
  93     /** This interface is implemented according to the specification of
  94         service <type>Content</type>.
  95      */
  96     interface com::sun::star::lang::XComponent;
  97
  98     //-------------------------------------------------------------------------
  99     /** This interface is implemented according to the specification of
 100         service <type>Content</type>.
 101      */
 102     interface com::sun::star::ucb::XContent;
 103
 104     //-------------------------------------------------------------------------
 105     /** This interface is implemented according to the specification of
 106         service <type>Content</type>.
 107
 108         <p>
 109
 110         <b>Supported Commands</b>
 111         <ul>
 112         <li>
 113         getCommandInfo
 114         </li>
 115         <li>
 116         getPropertySetInfo
 117         </li>
 118         <li>
 119         getPropertyValues
 120         </li>
 121         <li>
 122         setPropertyValues
 123         </li>
 124         <li>
 125         open
 126         </li>
 127         <li>
 128         transfer (only transfers TDCP documents, TDCP folders and TDCP streams.
 129         It does not handle contents with a URL scheme other than the TDOC URL
 130         scheme)
 131         </li>
 132         </ul>
 133
 134         <b>Supported Properties</b>
 135         <ul>
 136         <li>
 137         string ContentType ( read-only, always "application/vnd.sun.star.tdoc-document" )
 138         </li>
 139         <li>
 140         boolean IsDocument ( read-only, always false )
 141         </li>
 142         <li>
 143         boolean IsFolder ( read-only, always true )
 144         </li>
 145         <li>
 146         string Title ( read-only )
 147         </li>
 148         </ul>
 149
 150         </p>
 151      */
 152     interface com::sun::star::ucb::XCommandProcessor;
 153
 154     //-------------------------------------------------------------------------
 155     /** is an enhanced version of <type>XCommandProcessor</type> that has an
 156         additional method for releasing command identifiers obtained via
 157         <member>XCommandProcessor::createCommandIdentifier</member> to avoid
 158         resource leaks. For a detailed description of the problem refer to
 159         <member>XCommandProcessor2::releaseCommandIdentifier</member>.
 160
 161         <p>Where many existing <type>Content</type> implementations do not
 162         (yet), every new implementation should support this interface.
 163      */
 164     [optional] interface com::sun::star::ucb::XCommandProcessor2;
 165
 166     //-------------------------------------------------------------------------
 167     /** This interface is implemented according to the specification of
 168         service <type>Content</type>.
 169      */
 170     interface com::sun::star::beans::XPropertiesChangeNotifier;
 171
 172     //-------------------------------------------------------------------------
 173     /** This interface is implemented according to the specification of
 174         service <type>Content</type>.
 175      */
 176     interface com::sun::star::beans::XPropertyContainer;
 177
 178     //-------------------------------------------------------------------------
 179     /** This interface is implemented according to the specification of
 180         service <type>Content</type>.
 181      */
 182     interface com::sun::star::beans::XPropertySetInfoChangeNotifier;
 183
 184     //-------------------------------------------------------------------------
 185     /** This interface is implemented according to the specification of
 186         service <type>Content</type>.
 187      */
 188     interface com::sun::star::ucb::XCommandInfoChangeNotifier;
 189
 190     //-------------------------------------------------------------------------
 191     /** This interface is implemented according to the specification of
 192         service <type>Content</type>.
 193      */
 194     interface com::sun::star::container::XChild;
 195
 196     //-------------------------------------------------------------------------
 197     /** This interface is implemented according to the specification of
 198         service <type>Content</type>.
 199
 200         <p>To create a new child of a TDCP Document:
 201
 202         <ol>
 203         <li>
 204         Let the parent folder create a new content by calling
 205         <member>XContentCreator::createNewContent</member> on it. The content
 206         type to use for new folders is "application/vnd.sun.star.tdoc-folder".
 207         To create a new stream, use the type string
 208         "application/vnd.sun.star.tdoc-stream".
 209         </li>
 210         <li>
 211         Set a title for the new folder/stream. (Let the new child execute the
 212         command "setPropertyValues"; pass a non-empty value for the property
 213         "Title").
 214         </li>
 215         <li>
 216         Let the new child ( not the parent! ) execute the command "insert".
 217         This will commit the creation process. For streams, you need to supply
 218         the implementation of an
 219         <type scope="com::sun::star::io">XInputStream</type> with the command's
 220         parameters, that provides access to the stream data.
 221         </li>
 222         </ol>
 223
 224         </p>
 225      */
 226     interface com::sun::star::ucb::XContentCreator;
 227 };
 228
 229 //=============================================================================
 230
 231 }; }; }; };
 232
 233 #endif