1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23
24#ifndef __com_sun_star_form_runtime_FormOperations_idl__
25#define __com_sun_star_form_runtime_FormOperations_idl__
26
27#ifndef __com_sun_star_form_runtime_XFormOperations_idl__
28#include <com/sun/star/form/runtime/XFormOperations.idl>
29#endif
30#ifndef __com_sun_star_form_runtime_XFormController_idl__
31#include <com/sun/star/form/runtime/XFormController.idl>
32#endif
33#ifndef __com_sun_star_form_XForm_idl__
34#include <com/sun/star/form/XForm.idl>
35#endif
36#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
37#include <com/sun/star/lang/IllegalArgumentException.idl>
38#endif
39
40//=============================================================================
41
42module com { module sun { module star { module form { module runtime {
43
44//=============================================================================
45
46/** encapsulates operations on a database form which has a UI representation,
47    and is interacting with the user.
48
49    @since OpenOffice 2.2
50 */
51service FormOperations : XFormOperations
52{
53    /** creates a <code>FormOperations</code> instance which works on a <type scope="com::sun::star::form">FormController</type>
54        instance.
55        @throws IllegalArgumentException
56            if the given form controller is <NULL/>, or does not have a model denoting a valid
57            <type scope="com::sun::star::form::component">DataForm</type> instance.
58    */
59    createWithFormController(
60        [in] XFormController Controller
61    )
62    raises(
63        ::com::sun::star::lang::IllegalArgumentException
64    );
65
66    /** creates a <code>FormOperations</code> instance which works on a <type scope="com::sun::star::form::component">DataForm</type>
67        instance.
68
69        @throws IllegalArgumentException
70            if the given form is <NULL/>, or does not support the <type scope="com::sun::star::form::component">DataForm</type>
71            service.
72    */
73    createWithForm(
74        [in] XForm Form
75    )
76    raises(
77        ::com::sun::star::lang::IllegalArgumentException
78    );
79};
80
81//=============================================================================
82
83}; }; }; }; };
84
85//=============================================================================
86
87#endif
88