xref: /AOO41X/main/offapi/com/sun/star/sdbcx/XRename.idl (revision d1766043198e81d0bcfc626e12893e7b4d7e31ca)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_sdbcx_XRename_idl__
24#define __com_sun_star_sdbcx_XRename_idl__
25
26#ifndef __com_sun_star_uno_XInterface_idl__
27#include <com/sun/star/uno/XInterface.idl>
28#endif
29
30#ifndef __com_sun_star_sdbc_SQLException_idl__
31#include <com/sun/star/sdbc/SQLException.idl>
32#endif
33
34#ifndef __com_sun_star_container_ElementExistException_idl__
35#include <com/sun/star/container/ElementExistException.idl>
36#endif
37
38 module com {  module sun {  module star {  module sdbcx {
39
40/** supports the renaming of definition objects.
41    <br/>
42
43    This is a very desirable feature which is not supported by all databases. There is no
44    standard SQL statement provided for this feature.
45 */
46published interface XRename: com::sun::star::uno::XInterface
47{
48
49    /** is intended to alter the name of a object.
50        @param newName
51            the new name
52        @throws com::sun::star::sdbc::SQLException
53            if a database access error occurs.
54     */
55    void rename([in]string newName)
56        raises (com::sun::star::sdbc::SQLException,
57                com::sun::star::container::ElementExistException);
58};
59
60//=============================================================================
61
62}; }; }; };
63
64/*===========================================================================
65===========================================================================*/
66#endif
67