offapi/com/sun/star/form/XDatabaseParameterBroadcaster.idl

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