offapi/com/sun/star/xml/crypto/sax/XReferenceResolvedBroadcaster.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: XReferenceResolvedBroadcaster.idl,v $
  10  * $Revision: 1.4 $
  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
  31 //i20156 - new file for xmlsecurity module
  32
  33 /** -- idl definition -- **/
  34
  35 #ifndef __com_sun_star_xml_crypto_sax_xreferenceresolvedbroadcaster_idl_
  36 #define __com_sun_star_xml_crypto_sax_xreferenceresolvedbroadcaster_idl_
  37
  38 #include <com/sun/star/uno/XInterface.idl>
  39 #include <com/sun/star/uno/Exception.idl>
  40
  41 module com { module sun { module star { module xml { module crypto { module sax {
  42
  43 interface XReferenceResolvedListener;
  44
  45 /**
  46  * Interface of Reference Resolved Broadcaster.
  47  * <p>
  48  * This interface is used to manipulate reference resolved listener.
  49  */
  50 interface XReferenceResolvedBroadcaster : com::sun::star::uno::XInterface
  51 {
  52     /**
  53      * Adds a new reference resolved listener for a element collector.
  54      * <p>
  55      * When the element collector has completely collected that element,
  56      * this listener will receive a notification.
  57      *
  58      * @param referenceId   the id of the element collector for which
  59      *                      the new listener is added
  60      * @param listener      the listener to be added
  61      */
  62     void addReferenceResolvedListener(
  63         [in] long referenceId,
  64         [in] XReferenceResolvedListener listener);
  65
  66     /**
  67      * Removes a listener from a element collector.
  68      * <p>
  69      * When a listener is removed, it will not receive notification when
  70      * collection completes.
  71      *
  72      * @param referenceId   the id of the element collector from which
  73      *                      the listener is removed
  74      * @param listener      the listener to be removed
  75      */
  76     void removeReferenceResolvedListener(
  77         [in] long referenceId,
  78         [in] XReferenceResolvedListener listener);
  79 };
  80
  81 } ; } ; } ; } ; } ; } ;
  82
  83
  84 #endif
  85