1d1766043SAndrew Rist/**************************************************************
2d1766043SAndrew Rist *
3d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one
4d1766043SAndrew Rist * or more contributor license agreements.  See the NOTICE file
5d1766043SAndrew Rist * distributed with this work for additional information
6d1766043SAndrew Rist * regarding copyright ownership.  The ASF licenses this file
7d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the
8d1766043SAndrew Rist * "License"); you may not use this file except in compliance
9d1766043SAndrew Rist * with the License.  You may obtain a copy of the License at
10d1766043SAndrew Rist *
11d1766043SAndrew Rist *   http://www.apache.org/licenses/LICENSE-2.0
12d1766043SAndrew Rist *
13d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing,
14d1766043SAndrew Rist * software distributed under the License is distributed on an
15d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16d1766043SAndrew Rist * KIND, either express or implied.  See the License for the
17d1766043SAndrew Rist * specific language governing permissions and limitations
18d1766043SAndrew Rist * under the License.
19d1766043SAndrew Rist *
20d1766043SAndrew Rist *************************************************************/
21d1766043SAndrew Rist
22d1766043SAndrew Rist
23cdf0e10cSrcweir
24cdf0e10cSrcweir#ifndef __com_sun_star_sdb_XSubDocument_idl__
25cdf0e10cSrcweir#define __com_sun_star_sdb_XSubDocument_idl__
26cdf0e10cSrcweir
27cdf0e10cSrcweir#include <com/sun/star/lang/WrappedTargetException.idl>
28cdf0e10cSrcweir#include <com/sun/star/lang/XComponent.idl>
29cdf0e10cSrcweir
30cdf0e10cSrcweir//=============================================================================
31cdf0e10cSrcweir
32cdf0e10cSrcweirmodule com { module sun { module star { module sdb {
33cdf0e10cSrcweir
34cdf0e10cSrcweir//=============================================================================
35cdf0e10cSrcweir
36cdf0e10cSrcweir/** allows operating on a sub document of an <type>OfficeDatabaseDocument</type>
37cdf0e10cSrcweir
38*c4dc0a1aSJürgen Schmidt    @since OpenOffice 3.1
39cdf0e10cSrcweir */
40cdf0e10cSrcweirpublished interface XSubDocument
41cdf0e10cSrcweir{
42cdf0e10cSrcweir    /** opens the sub document
43cdf0e10cSrcweir
44cdf0e10cSrcweir        <p>Note that opening the document means it is displayed in an own top-level frame
45cdf0e10cSrcweir        on the desktop.</p>
46cdf0e10cSrcweir
47cdf0e10cSrcweir        @return
48cdf0e10cSrcweir            the sub document, usually an <type scope="com::sun::star::frame">XModel</type>,
49cdf0e10cSrcweir            or an <type scope="com::sun::star::frame">XController</type> if the sub document
50cdf0e10cSrcweir            does not have an own model.
51cdf0e10cSrcweir
52cdf0e10cSrcweir        @throws ::com::sun::star::lang::WrappedTargetException
53cdf0e10cSrcweir            if an error occurs during opening the document
54cdf0e10cSrcweir    */
55cdf0e10cSrcweir    ::com::sun::star::lang::XComponent
56cdf0e10cSrcweir            open()
57cdf0e10cSrcweir                raises( ::com::sun::star::lang::WrappedTargetException );
58cdf0e10cSrcweir
59cdf0e10cSrcweir    /** opens the sub document in design mode
60cdf0e10cSrcweir
61cdf0e10cSrcweir        @return
62cdf0e10cSrcweir            the sub document, usually an <type scope="com::sun::star::frame">XModel</type>,
63cdf0e10cSrcweir            or an <type scope="com::sun::star::frame">XController</type> if the sub document
64cdf0e10cSrcweir            does not have an own model.
65cdf0e10cSrcweir
66cdf0e10cSrcweir        @throws ::com::sun::star::lang::WrappedTargetException
67cdf0e10cSrcweir            if an error occurs during opening the document
68cdf0e10cSrcweir    */
69cdf0e10cSrcweir    ::com::sun::star::lang::XComponent
70cdf0e10cSrcweir            openDesign()
71cdf0e10cSrcweir                raises( ::com::sun::star::lang::WrappedTargetException );
72cdf0e10cSrcweir
73cdf0e10cSrcweir    /** stores the sub document, if it had previously been opened in either mode
74cdf0e10cSrcweir
75cdf0e10cSrcweir        @throws ::com::sun::star::lang::WrappedTargetException
76cdf0e10cSrcweir            if an error occurs during storing the document
77cdf0e10cSrcweir    */
78cdf0e10cSrcweir    void    store()
79cdf0e10cSrcweir                raises( ::com::sun::star::lang::WrappedTargetException );
80cdf0e10cSrcweir
81cdf0e10cSrcweir    /** closes the sub document, if it had previously been opened in either mode
82cdf0e10cSrcweir
83cdf0e10cSrcweir        @return <TRUE/> if and only if the document could be closed, <FALSE/> otherwise,
84cdf0e10cSrcweir            e.g. if the closing has been vetoed by the user.
85cdf0e10cSrcweir
86cdf0e10cSrcweir        @throws ::com::sun::star::lang::WrappedTargetException
87cdf0e10cSrcweir            if an error occurs during closing the document
88cdf0e10cSrcweir    */
89cdf0e10cSrcweir    boolean close()
90cdf0e10cSrcweir                raises( ::com::sun::star::lang::WrappedTargetException );
91cdf0e10cSrcweir};
92cdf0e10cSrcweir
93cdf0e10cSrcweir//=============================================================================
94cdf0e10cSrcweir
95cdf0e10cSrcweir}; }; }; };
96cdf0e10cSrcweir
97cdf0e10cSrcweir//=============================================================================
98cdf0e10cSrcweir
99cdf0e10cSrcweir#endif
100