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_RelationDesign_idl__
28#define __com_sun_star_sdb_RelationDesign_idl__
29
30#ifndef __com_sun_star_frame_XController_idl__
31#include <com/sun/star/frame/XController.idl>
32#endif
33#ifndef __com_sun_star_lang_XInitialization_idl__
34#include <com/sun/star/lang/XInitialization.idl>
35#endif
36#ifndef __com_sun_star_frame_XDispatchProvider_idl__
37#include <com/sun/star/frame/XDispatchProvider.idl>
38#endif
39#ifndef __com_sun_star_form_FormController_idl__
40#include <com/sun/star/form/FormController.idl>
41#endif
42
43module com {  module sun {  module star {  module sdb {
44
45//=============================================================================
46/** implements a component which allows the creation of relation.
47
48	<p>This service implements a user interface for relations through a graphical design interface.</p>
49
50	<p>The design view of the RelationDesign is identical to the first part of @see QueryDesign. It contains all tables
51	which are already connected through a relation.</p>
52
53	@see com::sun::star::sdb::ContentLoader
54	@see com::sun::star::frame::XDispatch
55	@see com::sun::star::frame::XDispatchProviderInterceptor
56
57    @since OOo 1.1.2
58*/
59
60published service RelationDesign
61{
62	/** allows the component to be plugged into frames.
63	*/
64	interface com::sun::star::frame::XController;
65
66	/** is used to initialize the RelationDesign.
67
68		<p>Parameters (passed to the method
69		<member scope="com::sun::star::lang">XInitialization::initialize</member>)
70		have to be instances of <type scope="com::sun::star::beans">PropertyValue</type>, where the
71		<member scope="com::sun::star::beans">PropertyValue::Name</member> member specifies what the parameter controls,
72		with the <member scope="com::sun::star::beans">PropertyValue::Value</member> member containing the value
73		to be used.<br>
74		Recognized parameters are:
75		<ul>
76			<li><b>Frame</b><br>
77			has to be an <type scope="com::sun::star::frame">XFrame</type> interface specifying the frame to plug the
78			RelationDesign component into.
79			</li>
80			<li><b>DataSourceName</b><br>
81			The name of the globally registered <type>DataSource</type> to be used for initial display. It is only
82			meaningful together with the other parameters specifying the object to display.
83			</li>
84		</ul>
85		</p>
86	*/
87	interface com::sun::star::lang::XInitialization;
88};
89
90//=============================================================================
91}; }; }; };
92
93#endif
94