dbaccess/source/ui/inc/objectnamecheck.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: objectnamecheck.hxx,v $
  10  * $Revision: 1.3 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef DBACCESS_SOURCE_UI_INC_OBJECTNAMECHECK_HXX
  32 #define DBACCESS_SOURCE_UI_INC_OBJECTNAMECHECK_HXX
  33
  34 /** === begin UNO includes === **/
  35 /** === end UNO includes === **/
  36
  37 namespace rtl { class OUString; }
  38 namespace dbtools { class SQLExceptionInfo; }
  39
  40 //........................................................................
  41 namespace dbaui
  42 {
  43 //........................................................................
  44
  45     //====================================================================
  46     //= IObjectNameCheck
  47     //====================================================================
  48     /** interface encapsulating the check for the validity of an object name
  49     */
  50     class IObjectNameCheck
  51     {
  52     public:
  53         /** determines whether a given object name is valid
  54
  55             @param  _rObjectName
  56                 the name to check
  57             @param  _out_rErrorToDisplay
  58                 output parameter taking an error message describing why the name is not
  59                 valid, if applicable.
  60
  61             @return
  62                 <TRUE/> if and only if the given name is valid.
  63         */
  64         virtual bool    isNameValid(
  65             const ::rtl::OUString& _rObjectName,
  66             ::dbtools::SQLExceptionInfo& _out_rErrorToDisplay
  67         ) const = 0;
  68
  69     public:
  70         virtual ~IObjectNameCheck() { }
  71     };
  72
  73 //........................................................................
  74 } // namespace dbaui
  75 //........................................................................
  76
  77 #endif // DBACCESS_SOURCE_UI_INC_OBJECTNAMECHECK_HXX