xref: /aoo42x/main/offapi/com/sun/star/sdbcx/XRename.idl (revision cdf0e10c)
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#ifndef __com_sun_star_sdbcx_XRename_idl__
28#define __com_sun_star_sdbcx_XRename_idl__
29
30#ifndef __com_sun_star_uno_XInterface_idl__
31#include <com/sun/star/uno/XInterface.idl>
32#endif
33
34#ifndef __com_sun_star_sdbc_SQLException_idl__
35#include <com/sun/star/sdbc/SQLException.idl>
36#endif
37
38#ifndef __com_sun_star_container_ElementExistException_idl__
39#include <com/sun/star/container/ElementExistException.idl>
40#endif
41
42 module com {  module sun {  module star {  module sdbcx {
43
44/** supports the renaming of definition objects.
45	<br/>
46
47	This is a very desirable feature which is not supported by all databases. There is no
48	standard SQL statement provided for this feature.
49 */
50published interface XRename: com::sun::star::uno::XInterface
51{
52
53	/** is intended to alter the name of a object.
54		@param newName
55			the new name
56		@throws com::sun::star::sdbc::SQLException
57			if a database access error occurs.
58	 */
59	void rename([in]string newName)
60		raises (com::sun::star::sdbc::SQLException,
61				com::sun::star::container::ElementExistException);
62};
63
64//=============================================================================
65
66}; }; }; };
67
68/*===========================================================================
69===========================================================================*/
70#endif
71