dbaccess/source/core/inc/objectnameapproval.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 <memory>
  23 #include "containerapprove.hxx"
  24
  25 #include <com/sun/star/sdbc/XConnection.hpp>
  26
  27 namespace dbaccess
  28 {
  29
  30     // ObjectNameApproval
  31     struct ObjectNameApproval_Impl;
  32     /** implementation of the IContainerApprove interface which approves
  33         elements for insertion into a query or tables container.
  34
  35         The only check done by this instance is whether the query name is
  36         not already used, taking into account that in some databases, queries
  37         and tables share the same namespace.
  38
  39         The class is not thread-safe.
  40     */
  41     class ObjectNameApproval : public IContainerApprove
  42     {
  43         std::unique_ptr< ObjectNameApproval_Impl >   m_pImpl;
  44
  45     public:
  46         enum ObjectType
  47         {
  48             TypeQuery,
  49             TypeTable
  50         };
  51
  52     public:
  53         /** constructs the instance
  54
  55             @param _rxConnection
  56                 the connection relative to which the names should be checked. This connection
  57                 will be held weak. In case it is closed, subsequent calls to this instance's
  58                 methods throw a DisposedException.
  59             @param _eType
  60                 specifies which type of objects is to be approved with this instance
  61         */
  62         ObjectNameApproval(
  63             const css::uno::Reference< css::sdbc::XConnection >& _rxConnection,
  64             ObjectType _eType
  65         );
  66         virtual ~ObjectNameApproval() override;
  67
  68         // IContainerApprove
  69         virtual void approveElement( const OUString& _rName ) override;
  70
  71     };
  72
  73 } // namespace dbaccess
  74
  75 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */