xref: /AOO41X/main/offapi/com/sun/star/form/runtime/FormOperations.idl (revision 1ecadb572e7010ff3b3382ad9bf179dbc6efadbb)
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
28#ifndef __com_sun_star_form_runtime_FormOperations_idl__
29#define __com_sun_star_form_runtime_FormOperations_idl__
30
31#ifndef __com_sun_star_form_runtime_XFormOperations_idl__
32#include <com/sun/star/form/runtime/XFormOperations.idl>
33#endif
34#ifndef __com_sun_star_form_runtime_XFormController_idl__
35#include <com/sun/star/form/runtime/XFormController.idl>
36#endif
37#ifndef __com_sun_star_form_XForm_idl__
38#include <com/sun/star/form/XForm.idl>
39#endif
40#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
41#include <com/sun/star/lang/IllegalArgumentException.idl>
42#endif
43
44//=============================================================================
45
46module com { module sun { module star { module form { module runtime {
47
48//=============================================================================
49
50/** encapsulates operations on a database form which has a UI representation,
51    and is interacting with the user.
52
53    @since OOo 2.2
54 */
55service FormOperations : XFormOperations
56{
57    /** creates a <code>FormOperations</code> instance which works on a <type scope="com::sun::star::form">FormController</type>
58        instance.
59        @throws IllegalArgumentException
60            if the given form controller is <NULL/>, or does not have a model denoting a valid
61            <type scope="com::sun::star::form::component">DataForm</type> instance.
62    */
63    createWithFormController(
64        [in] XFormController Controller
65    )
66    raises(
67        ::com::sun::star::lang::IllegalArgumentException
68    );
69
70    /** creates a <code>FormOperations</code> instance which works on a <type scope="com::sun::star::form::component">DataForm</type>
71        instance.
72
73        @throws IllegalArgumentException
74            if the given form is <NULL/>, or does not support the <type scope="com::sun::star::form::component">DataForm</type>
75            service.
76    */
77    createWithForm(
78        [in] XForm Form
79    )
80    raises(
81        ::com::sun::star::lang::IllegalArgumentException
82    );
83};
84
85//=============================================================================
86
87}; }; }; }; };
88
89//=============================================================================
90
91#endif
92