xref: /AOO41X/main/offapi/com/sun/star/sdbcx/XAlterTable.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_XAlterTable_idl__
24#define __com_sun_star_sdbcx_XAlterTable_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_container_NoSuchElementException_idl__
31#include <com/sun/star/container/NoSuchElementException.idl>
32#endif
33
34#ifndef __com_sun_star_lang_IndexOutOfBoundsException_idl__
35#include <com/sun/star/lang/IndexOutOfBoundsException.idl>
36#endif
37
38 module com {  module sun {  module star {  module beans {
39 published interface XPropertySet;
40};};};};
41
42#ifndef __com_sun_star_sdbc_SQLException_idl__
43#include <com/sun/star/sdbc/SQLException.idl>
44#endif
45
46 module com {  module sun {  module star {  module sdbcx {
47
48/** is used for creating and appending new objects to a specific container.
49 */
50published interface XAlterTable: com::sun::star::uno::XInterface
51{
52
53    /** is intended to alter an existing column identified by its name.
54        This operation must be atomic, in that it is done in one step.s
55
56        @param colName
57            the column name which to alter
58        @param descriptor
59            the new descriptor for the new column
60        @throws com::sun::star::sdbc::SQLException
61            if a database access error occurs.
62    */
63    void alterColumnByName([in]string colName,
64        [in]com::sun::star::beans::XPropertySet descriptor)
65        raises (com::sun::star::sdbc::SQLException,
66                com::sun::star::container::NoSuchElementException);
67    //-------------------------------------------------------------------------
68
69    /** is intended to alter an existing column identified by its position.
70        This operation must be atomic, in that it is done in one step.s
71
72        @param index
73            the position of the column to alter
74        @param descriptor
75            the new descriptor for the new column
76        @throws com::sun::star::sdbc::SQLException
77            if a database access error occurs.
78        @throws com::sun::star::lang::IndexOutOfBoundsException
79            if the given index does not denote an existing column.
80    */
81    void alterColumnByIndex([in]long index,
82        [in]com::sun::star::beans::XPropertySet descriptor) raises
83        (com::sun::star::sdbc::SQLException,
84         com::sun::star::lang::IndexOutOfBoundsException);
85};
86
87//=============================================================================
88
89}; }; }; };
90
91/*===========================================================================
92===========================================================================*/
93#endif
94