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