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_HierarchyRootFolderContent_idl__
28#define __com_sun_star_ucb_HierarchyRootFolderContent_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 HCP Root Folder is the root container for all other HCP Folders and HCP
76    Links.
77
78	<p>It always has the URL "vnd.sun.star.hier:/". A HCP Root Folder neither
79	can't be created nor deleted by a UCB client.
80
81	@see com::sun::star::ucb::HierarchyContentProvider
82	@see com::sun::star::ucb::HierarchyFolderContent
83	@see com::sun::star::ucb::HierarchyLinkContent
84*/
85published service HierarchyRootFolderContent
86{
87	//-------------------------------------------------------------------------
88	/** This interface is implemented according to the specification of
89		service <type>Content</type>.
90	 */
91	interface com::sun::star::lang::XComponent;
92
93	//-------------------------------------------------------------------------
94	/** This interface is implemented according to the specification of
95		service <type>Content</type>.
96	 */
97	interface com::sun::star::ucb::XContent;
98
99	//-------------------------------------------------------------------------
100	/** This interface is implemented according to the specification of
101		service <type>Content</type>.
102
103		<p>
104
105		<b>Supported Commands</b>
106		<ul>
107		<li>
108		getCommandInfo
109		</li>
110		<li>
111		getPropertySetInfo
112		</li>
113		<li>
114		getPropertyValues
115		</li>
116		<li>
117		setPropertyValues
118		</li>
119		<li>
120		open
121		</li>
122		<li>
123		transfer ( only transfers from one hierarchy folder to another supported )
124		</li>
125		</ul>
126
127		<b>Supported Properties</b>
128		<ul>
129		<li>
130		string ContentType ( read-only, always "application/vnd.sun.star.hier-folder" )
131		</li>
132		<li>
133		boolean IsDocument ( read-only, always false )
134		</li>
135		<li>
136		boolean IsFolder ( read-only, always true )
137		</li>
138		<li>
139		string Title ( read-only, always an empty string )
140		</li>
141		</ul>
142
143		</p>
144	 */
145	interface com::sun::star::ucb::XCommandProcessor;
146
147    //-------------------------------------------------------------------------
148    /** is an enhanced version of <type>XCommandProcessor</type> that has an
149        additional method for releasing command identifiers obtained via
150        <member>XCommandProcessor::createCommandIdentifier</member> to avoid
151        resource leaks. For a detailed description of the problem refer to
152        <member>XCommandProcessor2::releaseCommandIdentifier</member>.
153
154        <p>Where many existing <type>Content</type> implementations do not
155        (yet), every new implementation should support this interface.
156     */
157    [optional] interface com::sun::star::ucb::XCommandProcessor2;
158
159	//-------------------------------------------------------------------------
160	/** This interface is implemented according to the specification of
161		service <type>Content</type>.
162	 */
163	interface com::sun::star::beans::XPropertiesChangeNotifier;
164
165	//-------------------------------------------------------------------------
166	/** This interface is implemented according to the specification of
167		service <type>Content</type>.
168	 */
169	interface com::sun::star::beans::XPropertyContainer;
170
171	//-------------------------------------------------------------------------
172	/** This interface is implemented according to the specification of
173		service <type>Content</type>.
174	 */
175	interface com::sun::star::beans::XPropertySetInfoChangeNotifier;
176
177	//-------------------------------------------------------------------------
178	/** This interface is implemented according to the specification of
179		service <type>Content</type>.
180	 */
181	interface com::sun::star::ucb::XCommandInfoChangeNotifier;
182
183	//-------------------------------------------------------------------------
184	/** This interface is implemented according to the specification of
185		service <type>Content</type>.
186	 */
187	interface com::sun::star::container::XChild;
188
189	//-------------------------------------------------------------------------
190	/** This interface is implemented according to the specification of
191		service <type>Content</type>.
192
193		<p>
194
195		A HCP Root Folder can create HCP Folders and HCP Links. To create
196		a new child of a HCP Root Folder:
197
198		<ol>
199		<li>
200		Let the parent folder create a new content by calling
201		<member>XContentCreator::createNewContent</member> on it. The content
202		type to use for new folders is "application/vnd.sun.star.hier-folder".
203		To create a new link, use the type "application/vnd.sun.star.hier-link".
204		</li>
205		<li>
206		Set a title at the new folder / link. ( Let the new child execute
207		the command "setPropertyValues", which sets at least the property
208		"Title" to a non-empty value ). For a link, you need to set the
209		property "TargetURL" as well to a non-empty value.
210		</li>
211		<li>
212		Let the new child ( not the parent! ) execute the command "insert".
213		This will commit the creation process.
214		</li>
215		</ol>
216
217		</p>
218	 */
219	interface com::sun::star::ucb::XContentCreator;
220};
221
222//=============================================================================
223
224}; }; }; };
225
226#endif
227