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