dbaccess/source/core/inc/containerapprove.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef DBACCESS_CONTAINERAPPROVE_HXX
  21 #define DBACCESS_CONTAINERAPPROVE_HXX
  22
  23 #include <com/sun/star/uno/XInterface.hpp>
  24
  25 #include <boost/shared_ptr.hpp>
  26
  27 namespace dbaccess
  28 {
  29
  30     //====================================================================
  31     //= IContainerApprove
  32     //====================================================================
  33     /** interface for approving elements to be inserted into a container
  34
  35         On the long run, one could imagine that this interface completely encapsulates
  36         container/element approvals in all our various container classes herein (document
  37         containers, definition containers, table containers, query containers,
  38         command definition containers, bookmark containers). This would decrease coupling
  39         of the respective classes.
  40      */
  41     class SAL_NO_VTABLE IContainerApprove
  42     {
  43     public:
  44         virtual ~IContainerApprove() {}
  45
  46         /** approves a given element for insertion into the container
  47             @param  _rName
  48                 specifies the name under which the element is going to be inserted
  49             @param  _rxElement
  50                 specifies the element which is going to be inserted
  51             @throws Exception
  52                 if the name or the object are invalid, or not eligible for insertion
  53                 into the container
  54         */
  55         virtual void SAL_CALL   approveElement(
  56             const ::rtl::OUString& _rName,
  57             const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface >& _rxElement
  58         ) = 0;
  59     };
  60
  61     typedef ::boost::shared_ptr< IContainerApprove >    PContainerApprove;
  62
  63 } // namespace dbaccess
  64
  65 #endif // DBACCESS_CONTAINERAPPROVE_HXX
  66
  67 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */