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
24#ifndef __com_sun_star_sdb_tools_XTableAlteration_idl__
25#define __com_sun_star_sdb_tools_XTableAlteration_idl__
26
27#ifndef __com_sun_star_sdbc_SQLException_idl__
28#include <com/sun/star/sdbc/SQLException.idl>
29#endif
30#include <com/sun/star/sdb/tools/XConnectionSupplier.idl>
31#ifndef __com_sun_star_lang_XInitialization_idl__
32#include <com/sun/star/lang/XInitialization.idl>
33#endif
34#ifndef __com_sun_star_beans_XPropertySet_idl__
35#include <com/sun/star/beans/XPropertySet.idl>
36#endif
37
38//=============================================================================
39module com {  module sun {  module star {  module sdb { module tools {
40//=============================================================================
41
42//-----------------------------------------------------------------------------
43/** allows to alter a table.
44
45    @see com::sun::star::sdb::DataSource::Settings
46    @see com::sun::star::sdbcx::ColumnDescriptor
47    @see com::sun::star::sdbcx::XAlterTable
48    @see com::sun::star::sdbcx::XAppend
49    @see com::sun::star::sdbcx::XDrop
50
51    @since OpenOffice 3.3
52*/
53interface XTableAlteration
54{
55    interface XConnectionSupplier;
56
57    /** alter the column defined by name
58
59        @param table
60            the table to be altered
61
62        @param columnName
63            the name of the column to be changed
64
65        @param columnDescriptor
66            the column descriptor with the information of the new column definition
67
68        @throws com::sun::star::sdbc::SQLException
69        @see com::sun::star::sdbcx::XAlterTable
70    */
71    void  alterColumnByName( [in] com::sun::star::beans::XPropertySet table, [in] string columnName, [in] com::sun::star::beans::XPropertySet columnDescriptor)
72        raises ( com::sun::star::sdbc::SQLException );
73
74    /** creates a new object using the given descriptor and appends it
75		to the related container.
76		<b>
77		Note:
78		</b>
79		The descriptor will not be changed and can be used again to append another object.
80        @param table
81            the table to be altered
82		@param descriptor
83			the descriptor which should be serve to append a new object
84		@throws com::sun::star::sdbc::SQLException
85			if a database access error occurs.
86        @see com::sun::star::sdbcx::XAppend
87	 */
88	void addColumn([in] com::sun::star::beans::XPropertySet table,[in]com::sun::star::beans::XPropertySet descriptor)
89		raises (com::sun::star::sdbc::SQLException);
90
91    /** drops an object of the related container identified by its name.
92        @param table
93            the table to be altered
94		@param columnName
95			the name of the column to be dropped
96		@throws com::sun::star::sdbc::SQLException
97			if a database access error occurs.
98        @see com::sun::star::sdbcx::XDrop
99	 */
100	void dropColumn([in] com::sun::star::beans::XPropertySet table,[in]string columnName)
101	    raises ( com::sun::star::sdbc::SQLException);
102};
103//=============================================================================
104}; }; }; }; };
105//=============================================================================
106
107#endif
108
109