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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XDatabaseParameterBroadcaster.idl,v $
  10  * $Revision: 1.9 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_form_XDatabaseParameterBroadcaster_idl__
  31 #define __com_sun_star_form_XDatabaseParameterBroadcaster_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_form_XDatabaseParameterListener_idl__
  38 #include <com/sun/star/form/XDatabaseParameterListener.idl>
  39 #endif
  40
  41
  42 //=============================================================================
  43
  44  module com {  module sun {  module star {  module form {
  45
  46 //=============================================================================
  47
  48 /** provides the possibility of receiving an event for configuration of parameters.
  49     <p>This interface is usually implemented by components which are to execute a statement,
  50     and may need parameter information. For example, the
  51     <type scope="com::sun::star::form::component">DataForm</type> is such a component. When it is
  52     bound to a statement which contains parameters, or to a query which is based upon a parametrized
  53     statement, it needs values to fill in the parameters with actual values when it is being loaded.
  54     One method to gather these values is calling the <type>XDatabaseParameterListener</type> listeners, which
  55     can fill them in.</p>
  56  */
  57 published interface XDatabaseParameterBroadcaster: com::sun::star::uno::XInterface
  58 {
  59     //-------------------------------------------------------------------------
  60
  61     /** adds the specified listener, to allow it to fill in necessary parameter values.
  62         @param aListener
  63             the listener to add.
  64         @see com::sun::star::form::XDatabaseParameterListener
  65      */
  66     [oneway] void addParameterListener( [in] com::sun::star::form::XDatabaseParameterListener aListener );
  67
  68     //-------------------------------------------------------------------------
  69
  70     /** removes the specified listener.
  71         @param aListener
  72             the listener to remove.
  73         @see com::sun::star::form::XDatabaseParameterListener
  74      */
  75     [oneway] void removeParameterListener( [in] com::sun::star::form::XDatabaseParameterListener aListener );
  76
  77 };
  78
  79 //=============================================================================
  80
  81 }; }; }; };
  82
  83 /*=============================================================================
  84
  85 =============================================================================*/
  86 #endif