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_TransientDocumentsFolderContent_idl__
28#define __com_sun_star_ucb_TransientDocumentsFolderContent_idl__
29
30#ifndef __com_sun_star_lang_XComponent_idl__
31#include <com/sun/star/lang/XComponent.idl>
32#endif
33
34#ifndef __com_sun_star_ucb_XContent_idl__
35#include <com/sun/star/ucb/XContent.idl>
36#endif
37
38#ifndef __com_sun_star_ucb_XCommandProcessor_idl__
39#include <com/sun/star/ucb/XCommandProcessor.idl>
40#endif
41
42#ifndef __com_sun_star_ucb_XCommandProcessor2_idl__
43#include <com/sun/star/ucb/XCommandProcessor2.idl>
44#endif
45
46#ifndef __com_sun_star_beans_XPropertiesChangeNotifier_idl__
47#include <com/sun/star/beans/XPropertiesChangeNotifier.idl>
48#endif
49
50#ifndef __com_sun_star_beans_XPropertyContainer_idl__
51#include <com/sun/star/beans/XPropertyContainer.idl>
52#endif
53
54#ifndef __com_sun_star_beans_XPropertySetInfoChangeNotifier_idl__
55#include <com/sun/star/beans/XPropertySetInfoChangeNotifier.idl>
56#endif
57
58#ifndef __com_sun_star_ucb_XCommandInfoChangeNotifier_idl__
59#include <com/sun/star/ucb/XCommandInfoChangeNotifier.idl>
60#endif
61
62#ifndef __com_sun_star_container_XChild_idl__
63#include <com/sun/star/container/XChild.idl>
64#endif
65
66#ifndef __com_sun_star_ucb_XContentCreator_idl__
67#include <com/sun/star/ucb/XContentCreator.idl>
68#endif
69
70//=============================================================================
71
72module com { module sun { module star { module ucb {
73
74//=============================================================================
75/** A TDCP Folder is a container for other TDCP Folders and TDCP Streams.
76
77    <p>It may be contained in another TDCP Folder or in a TDCP Document.
78
79    @see TransientDocumentsContentProvider
80    @see TransientDocumentsRootContent
81    @see TransientDocumentsDocumentContent
82    @see TransientDocumentsStreamContent
83
84    @since OOo 2.0
85*/
86service TransientDocumentsFolderContent
87{
88	//-------------------------------------------------------------------------
89	/** This interface is implemented according to the specification of
90		service <type>Content</type>.
91	 */
92	interface com::sun::star::lang::XComponent;
93
94	//-------------------------------------------------------------------------
95	/** This interface is implemented according to the specification of
96		service <type>Content</type>.
97	 */
98	interface com::sun::star::ucb::XContent;
99
100	//-------------------------------------------------------------------------
101	/** This interface is implemented according to the specification of
102		service <type>Content</type>.
103
104		<p>
105
106		<b>Supported Commands</b>
107		<ul>
108		<li>
109		getCommandInfo
110		</li>
111		<li>
112		getPropertySetInfo
113		</li>
114		<li>
115		getPropertyValues
116		</li>
117		<li>
118		setPropertyValues
119		</li>
120		<li>
121		open
122		</li>
123        <li>
124        insert
125        </li>
126        <li>
127        delete
128        </li>
129        <li>
130        transfer (only transfers TDCP documents, TDCP folders and TDCP streams.
131        It does not handle contents with a URL scheme other than the TDOC URL
132        scheme)
133        </li>
134		</ul>
135
136		<b>Supported Properties</b>
137		<ul>
138		<li>
139        string ContentType ( read-only, always "application/vnd.sun.star.tdoc-folder" )
140		</li>
141		<li>
142		boolean IsDocument ( read-only, always false )
143		</li>
144		<li>
145		boolean IsFolder ( read-only, always true )
146		</li>
147		<li>
148        string Title
149		</li>
150        <li>
151        <type scope="com::sun::star::embed">XStorage</type> Storage ( read-only,
152        always a reference to a storage opened in read-only mode. No write
153        operations are possible. TDCP contents must be used for writing.)
154        </li>
155		</ul>
156
157		</p>
158	 */
159	interface com::sun::star::ucb::XCommandProcessor;
160
161    //-------------------------------------------------------------------------
162    /** is an enhanced version of <type>XCommandProcessor</type> that has an
163        additional method for releasing command identifiers obtained via
164        <member>XCommandProcessor::createCommandIdentifier</member> to avoid
165        resource leaks. For a detailed description of the problem refer to
166        <member>XCommandProcessor2::releaseCommandIdentifier</member>.
167
168        <p>Where many existing <type>Content</type> implementations do not
169        (yet), every new implementation should support this interface.
170     */
171    [optional] interface com::sun::star::ucb::XCommandProcessor2;
172
173	//-------------------------------------------------------------------------
174	/** This interface is implemented according to the specification of
175		service <type>Content</type>.
176	 */
177	interface com::sun::star::beans::XPropertiesChangeNotifier;
178
179	//-------------------------------------------------------------------------
180	/** This interface is implemented according to the specification of
181		service <type>Content</type>.
182	 */
183	interface com::sun::star::beans::XPropertyContainer;
184
185	//-------------------------------------------------------------------------
186	/** This interface is implemented according to the specification of
187		service <type>Content</type>.
188	 */
189	interface com::sun::star::beans::XPropertySetInfoChangeNotifier;
190
191	//-------------------------------------------------------------------------
192	/** This interface is implemented according to the specification of
193		service <type>Content</type>.
194	 */
195	interface com::sun::star::ucb::XCommandInfoChangeNotifier;
196
197	//-------------------------------------------------------------------------
198	/** This interface is implemented according to the specification of
199		service <type>Content</type>.
200	 */
201	interface com::sun::star::container::XChild;
202
203	//-------------------------------------------------------------------------
204	/** This interface is implemented according to the specification of
205		service <type>Content</type>.
206
207        <p>To create a new child of a TDCP Folder:
208
209		<ol>
210		<li>
211        Let the parent folder create a new content by calling
212        <member>XContentCreator::createNewContent</member> on it. The content
213        type to use for new folders is "application/vnd.sun.star.tdoc-folder".
214        To create a new stream, use the type string
215        "application/vnd.sun.star.tdoc-stream".
216		</li>
217		<li>
218        Set a title for the new folder/stream. (Let the new child execute the
219        command "setPropertyValues"; pass a non-empty value for the property
220        "Title").
221        </li>
222		<li>
223        Let the new child ( not the parent! ) execute the command "insert".
224        This will commit the creation process. For streams, you need to supply
225        the implementation of an
226        <type scope="com::sun::star::io">XInputStream</type> with the command's
227        parameters, that provides access to the stream data.
228		</li>
229		</ol>
230
231		</p>
232	 */
233	interface com::sun::star::ucb::XContentCreator;
234};
235
236//=============================================================================
237
238}; }; }; };
239
240#endif
241