dbaccess/source/ui/inc/objectnamecheck.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 INCLUDED_DBACCESS_SOURCE_UI_INC_OBJECTNAMECHECK_HXX
  21 #define INCLUDED_DBACCESS_SOURCE_UI_INC_OBJECTNAMECHECK_HXX
  22
  23 #include <rtl/ustring.hxx>
  24
  25 namespace dbtools { class SQLExceptionInfo; }
  26
  27 namespace dbaui
  28 {
  29
  30     // IObjectNameCheck
  31     /** interface encapsulating the check for the validity of an object name
  32     */
  33     class IObjectNameCheck
  34     {
  35     public:
  36         /** determines whether a given object name is valid
  37
  38             @param  _rObjectName
  39                 the name to check
  40             @param  _out_rErrorToDisplay
  41                 output parameter taking an error message describing why the name is not
  42                 valid, if applicable.
  43
  44             @return
  45                 <TRUE/> if and only if the given name is valid.
  46         */
  47         virtual bool    isNameValid(
  48             const OUString& _rObjectName,
  49             ::dbtools::SQLExceptionInfo& _out_rErrorToDisplay
  50         ) const = 0;
  51
  52     public:
  53         virtual ~IObjectNameCheck() { }
  54     };
  55
  56 } // namespace dbaui
  57
  58 #endif // INCLUDED_DBACCESS_SOURCE_UI_INC_OBJECTNAMECHECK_HXX
  59
  60 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */