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_TransientDocumentsRootContent_idl__
28#define __com_sun_star_ucb_TransientDocumentsRootContent_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//=============================================================================
67
68module com { module sun { module star { module ucb {
69
70//=============================================================================
71/** A TDCP Root Folder is the root container for all other DTCP contents.
72
73    <p>There is at most one instance of a TDCP Root at a time. All other TDCP
74    contents are children of this folder. The TDCP Root Folder can contain
75    only TDCP Documents. It has the fixed URL "vnd.sun.star.tdoc:/".
76
77    @see TransientDocumentsContentProvider
78    @see TransientDocumentsDocumentContent
79    @see TransientDocumentsFolderContent
80    @see TransientDocumentsStreamContent
81
82    @since OOo 2.0
83*/
84service TransientDocumentsRootContent
85{
86	//-------------------------------------------------------------------------
87	/** This interface is implemented according to the specification of
88		service <type>Content</type>.
89	 */
90	interface com::sun::star::lang::XComponent;
91
92	//-------------------------------------------------------------------------
93	/** This interface is implemented according to the specification of
94		service <type>Content</type>.
95	 */
96	interface com::sun::star::ucb::XContent;
97
98	//-------------------------------------------------------------------------
99	/** This interface is implemented according to the specification of
100		service <type>Content</type>.
101
102		<p>
103
104		<b>Supported Commands</b>
105		<ul>
106		<li>
107		getCommandInfo
108		</li>
109		<li>
110		getPropertySetInfo
111		</li>
112		<li>
113		getPropertyValues
114		</li>
115		<li>
116		setPropertyValues
117		</li>
118		<li>
119		open
120		</li>
121		</ul>
122
123		<b>Supported Properties</b>
124		<ul>
125		<li>
126        string ContentType ( read-only, always "application/vnd.sun.star.tdoc-root" )
127		</li>
128		<li>
129		boolean IsDocument ( read-only, always false )
130		</li>
131		<li>
132		boolean IsFolder ( read-only, always true )
133		</li>
134		<li>
135		string Title ( read-only, always an empty string )
136		</li>
137		</ul>
138
139		</p>
140	 */
141	interface com::sun::star::ucb::XCommandProcessor;
142
143    //-------------------------------------------------------------------------
144    /** is an enhanced version of <type>XCommandProcessor</type> that has an
145        additional method for releasing command identifiers obtained via
146        <member>XCommandProcessor::createCommandIdentifier</member> to avoid
147        resource leaks. For a detailed description of the problem refer to
148        <member>XCommandProcessor2::releaseCommandIdentifier</member>.
149
150        <p>Where many existing <type>Content</type> implementations do not
151        (yet), every new implementation should support this interface.
152     */
153    [optional] interface com::sun::star::ucb::XCommandProcessor2;
154
155	//-------------------------------------------------------------------------
156	/** This interface is implemented according to the specification of
157		service <type>Content</type>.
158	 */
159	interface com::sun::star::beans::XPropertiesChangeNotifier;
160
161	//-------------------------------------------------------------------------
162	/** This interface is implemented according to the specification of
163		service <type>Content</type>.
164	 */
165	interface com::sun::star::beans::XPropertyContainer;
166
167	//-------------------------------------------------------------------------
168	/** This interface is implemented according to the specification of
169		service <type>Content</type>.
170	 */
171	interface com::sun::star::beans::XPropertySetInfoChangeNotifier;
172
173	//-------------------------------------------------------------------------
174	/** This interface is implemented according to the specification of
175		service <type>Content</type>.
176	 */
177	interface com::sun::star::ucb::XCommandInfoChangeNotifier;
178
179	//-------------------------------------------------------------------------
180	/** This interface is implemented according to the specification of
181		service <type>Content</type>.
182	 */
183	interface com::sun::star::container::XChild;
184};
185
186//=============================================================================
187
188}; }; }; };
189
190#endif
191