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 #pragma once
  21
  22 #include <rtl/ustring.hxx>
  23
  24 #include <memory>
  25
  26 namespace dbaccess
  27 {
  28
  29     // IContainerApprove
  30     /** interface for approving elements to be inserted into a container
  31
  32         On the long run, one could imagine that this interface completely encapsulates
  33         container/element approvals in all our various container classes herein (document
  34         containers, definition containers, table containers, query containers,
  35         command definition containers, bookmark containers). This would decrease coupling
  36         of the respective classes.
  37      */
  38     class SAL_NO_VTABLE IContainerApprove
  39     {
  40     public:
  41         virtual ~IContainerApprove() {}
  42
  43         /** approves a given element for insertion into the container
  44             @param  _rName
  45                 specifies the name under which the element is going to be inserted
  46             @throws Exception
  47                 if the name or the object are invalid, or not eligible for insertion
  48                 into the container
  49         */
  50         virtual void   approveElement( const OUString& _rName ) = 0;
  51     };
  52
  53     typedef std::shared_ptr< IContainerApprove >    PContainerApprove;
  54
  55 } // namespace dbaccess
  56
  57 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */