offapi/com/sun/star/configuration/XTemplateInstance.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: XTemplateInstance.idl,v $
  10  * $Revision: 1.13 $
  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 #ifndef __com_sun_star_configuration_XTemplateInstance_idl__
  31 #define __com_sun_star_configuration_XTemplateInstance_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 //=============================================================================
  38
  39  module com {  module sun {  module star {  module configuration {
  40
  41 //=============================================================================
  42
  43 /** is implemented by objects that are instances of a named template to provide
  44     information about the template.
  45
  46     <p> Template names are similar to service names, but apply to structure and
  47         content, rather than to type.
  48     </p>
  49     <p> Often a template description can be retrieved from a repository and then be
  50         interpreted by a factory object. Templates provide a means to build
  51         new kinds of objects dynamically.
  52     </p>
  53
  54     @see XTemplateContainer
  55  */
  56 published interface XTemplateInstance: com::sun::star::uno::XInterface
  57 {
  58     //-------------------------------------------------------------------------
  59
  60     /** retrieves the name of the template
  61
  62         @returns
  63             the name of the template this object was built from or conforms to.
  64      */
  65     string getTemplateName();
  66
  67 };
  68
  69 //=============================================================================
  70
  71 }; }; }; };
  72
  73 #endif