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_form_XBoundComponent_idl__
28#define __com_sun_star_form_XBoundComponent_idl__
29
30#ifndef __com_sun_star_form_XUpdateBroadcaster_idl__
31#include <com/sun/star/form/XUpdateBroadcaster.idl>
32#endif
33
34
35//=============================================================================
36
37 module com {  module sun {  module star {  module form {
38
39//=============================================================================
40
41/**	specifies a (form) component which is bound to a data source.
42
43	<p>The interface provides the possibility of committing its respective
44	data to a data source it is bound to. A <member>commit</member> will be
45	performed by the environment (usually, a <type>FormController</type>).<br/>
46	For example, suppose you have a data-bound control that is connected
47	to a database field. Each time the control loses its focus, the
48	model (component) of the control is triggered by the environment
49	to store its value in the database field.</p>
50
51	<p>A commit may fail if an <type>XUpdateListener</type> vetoes the it.</p>
52
53	@see com::sun::star::form::XUpdateListener
54 */
55published interface XBoundComponent: com::sun::star::form::XUpdateBroadcaster
56{
57	//-------------------------------------------------------------------------
58
59	/** commits the content of the component into the data source it is bound to.
60
61		@returns
62			<TRUE/> when the commitment was successful, otherwise <FALSE/>.
63	 */
64	boolean commit();
65
66};
67
68//=============================================================================
69
70}; }; }; };
71
72/*=============================================================================
73
74=============================================================================*/
75#endif
76