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