summaryrefslogtreecommitdiff
path: root/configmgr/source/api2/groupaccess.hxx
blob: 7e4f6d033e2c03948d87f7623a0d6ef66de4d6a5 (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
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
/*************************************************************************
 *
 *  $RCSfile: groupaccess.hxx,v $
 *
 *  $Revision: 1.1 $
 *
 *  last change: $Author: jb $ $Date: 2000-11-07 14:34:32 $
 *
 *  The Contents of this file are made available subject to the terms of
 *  either of the following licenses
 *
 *         - GNU Lesser General Public License Version 2.1
 *         - Sun Industry Standards Source License Version 1.1
 *
 *  Sun Microsystems Inc., October, 2000
 *
 *  GNU Lesser General Public License Version 2.1
 *  =============================================
 *  Copyright 2000 by Sun Microsystems, Inc.
 *  901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License version 2.1, as published by the Free Software Foundation.
 *
 *  This library 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 for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *  MA  02111-1307  USA
 *
 *
 *  Sun Industry Standards Source License Version 1.1
 *  =================================================
 *  The contents of this file are subject to the Sun Industry Standards
 *  Source License Version 1.1 (the "License"); You may not use this file
 *  except in compliance with the License. You may obtain a copy of the
 *  License at http://www.openoffice.org/license.html.
 *
 *  Software provided under this License is provided on an "AS IS" basis,
 *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
 *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
 *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
 *  See the License for the specific provisions governing your rights and
 *  obligations concerning the Software.
 *
 *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
 *
 *  Copyright: 2000 by Sun Microsystems, Inc.
 *
 *  All Rights Reserved.
 *
 *  Contributor(s): _______________________________________
 *
 *
 ************************************************************************/

#ifndef CONFIGMGR_API_GROUPACCESS_HXX_
#define CONFIGMGR_API_GROUPACCESS_HXX_

#ifndef _COM_SUN_STAR_CONTAINER_XHIERARCHICALNAME_HPP_
#include <com/sun/star/container/XHierarchicalName.hpp>
#endif
#ifndef _COM_SUN_STAR_CONTAINER_XNAMEACCESS_HPP_
#include <com/sun/star/container/XNameAccess.hpp>
#endif
#ifndef _COM_SUN_STAR_CONTAINER_XHIERARCHICALNAMEACCESS_HPP_
#include <com/sun/star/container/XHierarchicalNameAccess.hpp>
#endif
#ifndef _COM_SUN_STAR_CONTAINER_XCONTAINER_HPP_
#include <com/sun/star/container/XContainer.hpp>
#endif
#ifndef _COM_SUN_STAR_BEANS_XEXACTNAME_HPP_
#include <com/sun/star/beans/XExactName.hpp>
#endif
#ifndef _COM_SUN_STAR_BEANS_XPROPERTY_HPP_
#include <com/sun/star/beans/XProperty.hpp>
#endif

#ifndef _CPPUHELPER_IMPLBASE6_HXX_
#include <cppuhelper/implbase6.hxx>
#endif

#ifndef CONFIGMGR_APITYPES_HXX_
#include "apitypes.hxx"
#endif

namespace configmgr
{
    namespace css = ::com::sun::star;
    namespace uno = ::com::sun::star::uno;

    namespace configapi { class NodeGroupInfoAccess; }

    /** implements the (read-only) interfaces supported by a group node
        within the configuration tree.
        <p> Is an interface adapter around <type scope='configmgr::configapi'>NodeAccess</type>.</p>
    */
    class BasicGroupAccess
    : public ::cppu::ImplHelper6
                < css::container::XNameAccess
                , css::container::XHierarchicalName
                , css::container::XHierarchicalNameAccess
                , css::container::XContainer
                , css::beans::XExactName
                , css::beans::XProperty
                >
    {
    protected:
    // Destructors
        virtual ~BasicGroupAccess() {}

    public:
    // Interface methods

        // XHierarchicalName
        virtual OUString SAL_CALL 
            getHierarchicalName(  ) 
                throw(uno::RuntimeException);

        virtual OUString SAL_CALL 
            composeHierarchicalName( const OUString& aRelativeName ) 
                throw(css::lang::IllegalArgumentException, css::lang::NoSupportException, 
                        uno::RuntimeException);

        // XElementAccess, base class of XNameAccess 
        virtual uno::Type SAL_CALL 
            getElementType(  ) 
                throw(uno::RuntimeException);

        virtual sal_Bool SAL_CALL 
            hasElements(  ) 
                throw(uno::RuntimeException);

        // XNameAccess
        virtual uno::Any SAL_CALL 
            getByName( const OUString& aName ) 
                throw(css::container::NoSuchElementException, css::lang::WrappedTargetException, 
                         uno::RuntimeException);
 
        virtual uno::Sequence< OUString > SAL_CALL 
            getElementNames(  ) 
                throw( uno::RuntimeException);

        virtual sal_Bool SAL_CALL 
            hasByName( const OUString& aName ) 
                throw(uno::RuntimeException);

        // XHierarchicalNameAccess
        virtual uno::Any SAL_CALL 
            getByHierarchicalName( const OUString& aName ) 
                throw(css::container::NoSuchElementException, uno::RuntimeException);

        virtual sal_Bool SAL_CALL 
            hasByHierarchicalName( const OUString& aName ) 
                throw(uno::RuntimeException);

        // XContainer
        virtual void SAL_CALL 
            addContainerListener( const uno::Reference< css::container::XContainerListener >& xListener ) 
                throw(uno::RuntimeException);

        virtual void SAL_CALL 
            removeContainerListener( const uno::Reference< css::container::XContainerListener >& xListener ) 
                throw(uno::RuntimeException);
    
        // XExactName
        virtual ::rtl::OUString SAL_CALL 
            getExactName( const OUString& aApproximateName ) 
                throw(uno::RuntimeException);

        // XProperty
        virtual css::beans::Property SAL_CALL 
            getAsProperty(  ) 
                throw(uno::RuntimeException);

    protected:
        virtual configapi::NodeGroupInfoAccess& getNode() = 0;
    };

}
#endif // CONFIGMGR_API_GROUPACCESS_HXX_