configmgr/source/api2/accessimpl.hxx

   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: accessimpl.hxx,v $
  10  * $Revision: 1.7 $
  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 CONFIGMGR_API_BASEACCESSIMPL_HXX_
  32 #define CONFIGMGR_API_BASEACCESSIMPL_HXX_
  33
  34 #include <com/sun/star/container/XHierarchicalName.hpp>
  35 #include <com/sun/star/container/XNameAccess.hpp>
  36 #include <com/sun/star/container/XHierarchicalNameAccess.hpp>
  37 #include <com/sun/star/configuration/XTemplateInstance.hpp>
  38 #include <com/sun/star/configuration/XTemplateContainer.hpp>
  39 #include <com/sun/star/beans/XExactName.hpp>
  40 #include <com/sun/star/beans/XProperty.hpp>
  41 #include <com/sun/star/beans/XPropertySetInfo.hpp>
  42 #include <com/sun/star/beans/XPropertyWithState.hpp>
  43
  44 namespace configmgr
  45 {
  46     namespace css = ::com::sun::star;
  47     namespace uno = ::com::sun::star::uno;
  48
  49     /* implementations of the interfaces supported by a (parent) node
  50         within the configuration tree.
  51         (read-only operation)
  52     */
  53     namespace configapi
  54     {
  55         class NodeAccess;
  56         class NodeSetInfoAccess;
  57         class NodeGroupInfoAccess;
  58
  59         // XHierarchicalName
  60         rtl::OUString implGetHierarchicalName(NodeAccess& rNode)
  61             throw(uno::RuntimeException);
  62
  63         rtl::OUString implComposeHierarchicalName(NodeGroupInfoAccess& rNode, const rtl::OUString& aRelativeName )
  64             throw(css::lang::IllegalArgumentException, css::lang::NoSupportException, uno::RuntimeException);
  65
  66         rtl::OUString implComposeHierarchicalName(NodeSetInfoAccess& rNode, const rtl::OUString& aRelativeName )
  67             throw(css::lang::IllegalArgumentException, css::lang::NoSupportException, uno::RuntimeException);
  68
  69         // XElementAccess, base class of XNameAccess
  70         uno::Type implGetElementType(NodeGroupInfoAccess& rNode)
  71             throw(uno::RuntimeException);
  72
  73         uno::Type implGetElementType(NodeSetInfoAccess& rNode)
  74             throw(uno::RuntimeException);
  75
  76         sal_Bool implHasElements(NodeGroupInfoAccess& rNode)
  77             throw(uno::RuntimeException);
  78
  79         sal_Bool implHasElements(NodeSetInfoAccess& rNode)
  80             throw(uno::RuntimeException);
  81
  82         // XNameAccess
  83         uno::Any implGetByName(NodeAccess& rNode, const rtl::OUString& aName )
  84             throw(css::container::NoSuchElementException, css::lang::WrappedTargetException, uno::RuntimeException);
  85
  86         uno::Sequence< rtl::OUString > implGetElementNames(NodeAccess& rNode)
  87             throw( uno::RuntimeException);
  88
  89         sal_Bool implHasByName(NodeAccess& rNode, const rtl::OUString& aName )
  90             throw(uno::RuntimeException);
  91
  92         // XHierarchicalNameAccess
  93         uno::Any implGetByHierarchicalName(NodeAccess& rNode, const rtl::OUString& aName )
  94             throw(css::container::NoSuchElementException, uno::RuntimeException);
  95
  96         sal_Bool implHasByHierarchicalName(NodeAccess& rNode, const rtl::OUString& aName )
  97             throw(uno::RuntimeException);
  98
  99         // XExactName
 100         rtl::OUString implGetExactName(NodeGroupInfoAccess& rNode, const rtl::OUString& aApproximateName )
 101             throw(uno::RuntimeException);
 102
 103         rtl::OUString implGetExactName(NodeSetInfoAccess& rNode, const rtl::OUString& aApproximateName )
 104             throw(uno::RuntimeException);
 105
 106         // XProperty
 107         css::beans::Property implGetAsProperty(NodeAccess& rNode)
 108             throw(uno::RuntimeException);
 109
 110         // XPropertySetInfo
 111         uno::Sequence< css::beans::Property > implGetProperties( NodeAccess& rNode )
 112             throw (uno::RuntimeException);
 113
 114         css::beans::Property implGetPropertyByName( NodeAccess& rNode, const rtl::OUString& aName )
 115             throw (css::beans::UnknownPropertyException, uno::RuntimeException);
 116
 117         sal_Bool implHasPropertyByName( NodeAccess& rNode, const rtl::OUString& name )
 118             throw (uno::RuntimeException);
 119
 120
 121         // XPropertyWithState
 122         css::beans::PropertyState implGetStateAsProperty(NodeAccess& rNode)
 123             throw (uno::RuntimeException);
 124
 125         uno::Reference< uno::XInterface > implGetDefaultAsProperty(NodeAccess& rNode)
 126             throw (css::lang::WrappedTargetException, uno::RuntimeException);
 127
 128         // set-specific interfaces
 129
 130         // XTemplateContainer
 131         rtl::OUString SAL_CALL implGetElementTemplateName(NodeSetInfoAccess& rNode)
 132             throw(uno::RuntimeException);
 133
 134     }
 135
 136 }
 137 #endif // CONFIGMGR_API_BASEACCESSIMPL_HXX_
 138
 139