summaryrefslogtreecommitdiff
path: root/udkapi/com/sun/star/reflection/XServiceTypeDescription.idl
blob: ab02dda44bff23d75cd2a57142272a161d7a1bc7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/

#ifndef __com_sun_star_reflection_XServiceTypeDescription_idl__
#define __com_sun_star_reflection_XServiceTypeDescription_idl__

#include <com/sun/star/uno/XInterface.idl>
#include <com/sun/star/reflection/XInterfaceTypeDescription.idl>
#include <com/sun/star/reflection/XPropertyTypeDescription.idl>

//=============================================================================

 module com {  module sun {  module star {  module reflection {

//=============================================================================

/** Reflects a service.

    <p>This type is superseded by <type>XServiceTypeDescription2</type>, which
    supports single-interface&ndash;based services, in addition to the obsolete,
    accumulation-based services.</p>

    <p>The type class of this type is
    <member scope="com::sun::star::uno">TypeClass::SERVICE</member>.

    @since OOo 1.1.2
  */
published interface XServiceTypeDescription : com::sun::star::reflection::XTypeDescription
{
    /** Returns the type descriptions of the mandatory services
        defined for this service.

        @return a sequence containing service type descriptions, for an
            obsolete, accumulation-based service; for a
            single-interface&ndash;based service, an empty sequence is returned
      */
    sequence< XServiceTypeDescription > getMandatoryServices();

    /** Returns the type descriptions of the optional services
        defined for this service.

        @return a sequence containing service type descriptions, for an
            obsolete, accumulation-based service; for a
            single-interface&ndash;based service, an empty sequence is returned
      */
    sequence< XServiceTypeDescription > getOptionalServices();

    /** Returns the type descriptions of the mandatory interfaces
        defined for this service.

        @return a sequence containing interface type descriptions, for an
            obsolete, accumulation-based service; for a
            single-interface&ndash;based service, an empty sequence is returned
      */
    sequence< XInterfaceTypeDescription > getMandatoryInterfaces();

    /** Returns the type descriptions of the optional interface
        defined for this service.

        @return a sequence containing interface type descriptions, for an
            obsolete, accumulation-based service; for a
            single-interface&ndash;based service, an empty sequence is returned
      */
    sequence< XInterfaceTypeDescription > getOptionalInterfaces();

    /** Returns the properties defined for this service.

        @return a sequence containing property descriptions, for an obsolete,
            accumulation-based service; for a single-interface&ndash;based
            service, an empty sequence is returned
      */
    sequence< XPropertyTypeDescription > getProperties();
};

//=============================================================================

}; }; }; };

#endif