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