xref: /aoo41x/main/offapi/com/sun/star/frame/XModule.idl (revision c4dc0a1a)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23
24#ifndef __com_sun_star_frame_XModule_idl__
25#define __com_sun_star_frame_XModule_idl__
26
27#ifndef __com_sun_star_uno_XInterface_idl__
28#include <com/sun/star/uno/XInterface.idl>
29#endif
30
31#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
32#include <com/sun/star/lang/IllegalArgumentException.idl>
33#endif
34
35#ifndef __com_sun_star_frame_UnknownModuleException_idl__
36#include <com/sun/star/frame/UnknownModuleException.idl>
37#endif
38
39//===============================================
40
41module com { module sun { module star { module frame {
42
43//===============================================
44/** can be used to overrule identification of office modules.
45
46    <p>
47    Normaly an office module will be identified by it's service name
48    in combination with a set of configuration data.
49    But sometimes whole existing office modules will be used as black box components
50    to implement a different office module on top of it. Patching a service name
51    is not possible. So this optional interface can be used to overwrite identification
52    of a module.
53    </p>
54
55    @see XModuleManager
56
57    @since OpenOffice 2.3
58 */
59interface XModule : com::sun::star::uno::XInterface
60{
61    //-------------------------------------------
62    /** @param  Identifier
63                a new "name" for this module.
64     */
65    void setIdentifier([in] string Identifier);
66
67    //-------------------------------------------
68    /** @return the module identifier.
69     */
70    string getIdentifier();
71};
72
73}; }; }; };
74
75#endif
76