xref: /aoo41x/main/offapi/com/sun/star/frame/XModule.idl (revision cdf0e10c)
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#ifndef __com_sun_star_frame_XModule_idl__
29#define __com_sun_star_frame_XModule_idl__
30
31#ifndef __com_sun_star_uno_XInterface_idl__
32#include <com/sun/star/uno/XInterface.idl>
33#endif
34
35#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
36#include <com/sun/star/lang/IllegalArgumentException.idl>
37#endif
38
39#ifndef __com_sun_star_frame_UnknownModuleException_idl__
40#include <com/sun/star/frame/UnknownModuleException.idl>
41#endif
42
43//===============================================
44
45module com { module sun { module star { module frame {
46
47//===============================================
48/** can be used to overrule identification of office modules.
49
50    <p>
51    Normaly an office module will be identified by it's service name
52    in combination with a set of configuration data.
53    But sometimes whole existing office modules will be used as black box components
54    to implement a different office module on top of it. Patching a service name
55    is not possible. So this optional interface can be used to overwrite identification
56    of a module.
57    </p>
58
59    @see XModuleManager
60
61    @since OOo 2.3
62 */
63interface XModule : com::sun::star::uno::XInterface
64{
65    //-------------------------------------------
66    /** @param  Identifier
67                a new "name" for this module.
68     */
69    void setIdentifier([in] string Identifier);
70
71    //-------------------------------------------
72    /** @return the module identifier.
73     */
74    string getIdentifier();
75};
76
77}; }; }; };
78
79#endif
80