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_XIndexAlteration_idl__
25#define __com_sun_star_sdb_tools_XIndexAlteration_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 the indexes of a table.
44
45    @see com::sun::star::sdb::DataSource::Settings
46    @see com::sun::star::sdbcx::XAppend
47    @see com::sun::star::sdbcx::XDrop
48
49    @since OpenOffice 3.3
50*/
51interface XIndexAlteration
52{
53    interface XConnectionSupplier;
54
55    /** drops an object of the related container identified by its name.
56        @param table
57            the table to be altered
58		@param index
59			the name of the column to be dropped
60		@throws com::sun::star::sdbc::SQLException
61			if a database access error occurs.
62	 */
63	void dropIndex([in] com::sun::star::beans::XPropertySet table,[in] string index)
64	    raises ( com::sun::star::sdbc::SQLException);
65
66    /** creates a new object using the given descriptor and appends it
67		to the related container.
68		<b>
69		Note:
70		</b>
71		The descriptor will not be changed and can be used again to append another object.
72        @param table
73            the table to be altered
74		@param descriptor
75			the descriptor which should be serve to append a new object
76		@throws com::sun::star::sdbc::SQLException
77			if a database access error occurs.
78	 */
79	void addIndex([in] com::sun::star::beans::XPropertySet table,[in]com::sun::star::beans::XPropertySet descriptor)
80		raises (com::sun::star::sdbc::SQLException);
81
82
83};
84//=============================================================================
85}; }; }; }; };
86//=============================================================================
87
88#endif
89
90