xref: /AOO41X/main/offapi/com/sun/star/form/XDatabaseParameterBroadcaster.idl (revision d1766043198e81d0bcfc626e12893e7b4d7e31ca)
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#ifndef __com_sun_star_form_XDatabaseParameterBroadcaster_idl__
24#define __com_sun_star_form_XDatabaseParameterBroadcaster_idl__
25
26#ifndef __com_sun_star_uno_XInterface_idl__
27#include <com/sun/star/uno/XInterface.idl>
28#endif
29
30#ifndef __com_sun_star_form_XDatabaseParameterListener_idl__
31#include <com/sun/star/form/XDatabaseParameterListener.idl>
32#endif
33
34
35//=============================================================================
36
37 module com {  module sun {  module star {  module form {
38
39//=============================================================================
40
41/** provides the possibility of receiving an event for configuration of parameters.
42    <p>This interface is usually implemented by components which are to execute a statement,
43    and may need parameter information. For example, the
44    <type scope="com::sun::star::form::component">DataForm</type> is such a component. When it is
45    bound to a statement which contains parameters, or to a query which is based upon a parametrized
46    statement, it needs values to fill in the parameters with actual values when it is being loaded.
47    One method to gather these values is calling the <type>XDatabaseParameterListener</type> listeners, which
48    can fill them in.</p>
49 */
50published interface XDatabaseParameterBroadcaster: com::sun::star::uno::XInterface
51{
52    //-------------------------------------------------------------------------
53
54    /** adds the specified listener, to allow it to fill in necessary parameter values.
55        @param aListener
56            the listener to add.
57        @see com::sun::star::form::XDatabaseParameterListener
58     */
59    [oneway] void addParameterListener( [in] com::sun::star::form::XDatabaseParameterListener aListener );
60
61    //-------------------------------------------------------------------------
62
63    /** removes the specified listener.
64        @param aListener
65            the listener to remove.
66        @see com::sun::star::form::XDatabaseParameterListener
67     */
68    [oneway] void removeParameterListener( [in] com::sun::star::form::XDatabaseParameterListener aListener );
69
70};
71
72//=============================================================================
73
74}; }; }; };
75
76/*=============================================================================
77
78=============================================================================*/
79#endif
80