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