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