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_sdb_DocumentContainer_idl__
28#define __com_sun_star_sdb_DocumentContainer_idl__
29
30#ifndef __com_sun_star_sdb_DefinitionContainer_idl__
31#include <com/sun/star/sdb/DefinitionContainer.idl>
32#endif
33#ifndef __com_sun_star_sdb_DefinitionContent_idl__
34#include <com/sun/star/sdb/DefinitionContent.idl>
35#endif
36
37
38 module com {  module sun {  module star {  module lang {
39 published interface XMultiServiceFactory;
40};};};};
41
42 module com {  module sun {  module star {  module frame {
43 published interface XComponentLoader;
44};};};};
45
46  module com {  module sun {  module star {  module container {
47 published interface XHierarchicalNameContainer;
48};};};};
49
50
51 module com {  module sun {  module star {  module sdb {
52
53
54/** describes a container which provides access to documents embedded into a database document,
55    usually forms and reports.
56
57	<p>The <member scope="com::sun::star::lang">XMultiServiceFactory::createInstanceWithArguments()</member>
58	should be used to create sub document container or form, or report objects.</p>
59
60    <p>The embedded documents do not support any particular database related service, instead, they're
61    usual <type scope="com::sun::star::document">OfficeDocument</type>s.<br/>
62    The only thing worth mentioning here is that they support the
63    <type scope="com::sun::star::container">XChild</type> interface, whose
64    <member scope="com::sun::star::container">XChild::getParent</member> method can be used to
65    obtain the database document which the embedded document belongs to.
66    </p>
67
68	@see DocumentDefinition
69    @see OfficeDatabaseDocument
70 */
71service DocumentContainer
72{
73	service DefinitionContainer;
74
75    /** provides functionality for treating the container as part of a hierarchy
76        of a database document's sub documents.
77
78        <p>The <member scope="com::sun::star::ucb">XCommandProcessor::execute</member> method
79        of a <code>DocumentDefinition</code> supports at least the following commands, additionally to
80        the ones already supported by the DefinitionContent:
81        <ul>
82            <li><strong>open</strong>: provides a <type scope="com::sun::star::ucb::">XDynamicResultSet</type>
83                to enumerate the content of the document container.</li>
84            <li><strong>delete</strong>: deletes the document container, including all contained documents.</li>
85        </ul>
86    */
87    service DefinitionContent;
88
89	/** can be used to load the document inside.
90		<p>
91		URL: describes the name of the document definition to load,
92		TargetFrameName: isn't used.
93		SearchFlags: isn't used.
94		Arguments:
95		<ol>
96			<li>PropertyValue</li>
97				Name = ActiveConnection
98				Value = The connection which should be used when opening the text document.
99			<li>PropertyValue</li>
100				Name = OpenMode
101				Value = string, "open" if the document should be opened in live mode (editing is not possible),
102								"openDesign" if the document should be open in design mode (editing is possible)
103		</ol>
104		@see com::sun::star::sdbc::XConnection
105		</p>
106	*/
107	interface com::sun::star::frame::XComponentLoader;
108
109	/** can be used to create container elements.
110		<p>
111		If this interface is supported, the object created using it (e.g., the object returned by
112		<method scope="com.sun.star.lang">XMultiServiceFactory::createInstanceWithArguments()</method>
113		) can be used as container elements.
114		</p>
115	 */
116	interface com::sun::star::lang::XMultiServiceFactory;
117
118	/** can be used to create folder hierarchies and to organize forms or reports in different sub folders.
119	*/
120	interface com::sun::star::container::XHierarchicalNameContainer;
121};
122
123//=============================================================================
124
125}; }; }; };
126
127/*===========================================================================
128===========================================================================*/
129#endif
130