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