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