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_XDocumentDataSource_idl__
28#define __com_sun_star_sdb_XDocumentDataSource_idl__
29
30#ifndef __com_sun_star_sdb_XOfficeDatabaseDocument_idl__
31#include <com/sun/star/sdb/XOfficeDatabaseDocument.idl>
32#endif
33
34//=============================================================================
35
36 module com {  module sun {  module star {  module sdb {
37
38//=============================================================================
39/** simplifies the accessing of data sources and their corresponding database document.
40
41    <p>
42    The interface can be used to access the data source of the database document.
43    </p>
44    @see OfficeDatabaseDocument
45 */
46published interface XDocumentDataSource
47{
48    /** provides access to the one and only <type>OfficeDatabaseDocument</type>
49        which the data source is based on.
50
51        <p>The component returned by this attribute is an <type>OfficeDatabaseDocument</type>.</p>
52
53        <p>Though there is a 1-to-1 relationship between database documents and data sources,
54        each of the two can exist without its counterpart, but create this counterpart on request
55        only. As a consequence, the document obtained via this attribute might be newly created,
56        which implies that the caller is now responsible for it. In particular, the caller is
57        responsible for calling <member scope="com::sun::star::util">XCloseable::close</member>
58        on the document as soon as it's not needed anymore.</p>
59
60        <p>Additionally, if the caller does long-lasting processing on the document, it's advised
61        to add itself as <type scope="com::sun::star::util">XCloseListener</type> to the document,
62        to prevent closing as long as the processing lasts.</p>
63    */
64    [readonly, attribute] XOfficeDatabaseDocument DatabaseDocument;
65};
66
67//=============================================================================
68
69}; }; }; };
70
71/*=============================================================================
72
73=============================================================================*/
74#endif
75
76