1*cdf0e10cSrcweir/*************************************************************************
2*cdf0e10cSrcweir *
3*cdf0e10cSrcweir * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4*cdf0e10cSrcweir *
5*cdf0e10cSrcweir * Copyright 2008 by Sun Microsystems, Inc.
6*cdf0e10cSrcweir *
7*cdf0e10cSrcweir * OpenOffice.org - a multi-platform office productivity suite
8*cdf0e10cSrcweir *
9*cdf0e10cSrcweir * $RCSfile: XIndexAlteration.idl,v $
10*cdf0e10cSrcweir * $Revision: 1.3 $
11*cdf0e10cSrcweir *
12*cdf0e10cSrcweir * This file is part of OpenOffice.org.
13*cdf0e10cSrcweir *
14*cdf0e10cSrcweir * OpenOffice.org is free software: you can redistribute it and/or modify
15*cdf0e10cSrcweir * it under the terms of the GNU Lesser General Public License version 3
16*cdf0e10cSrcweir * only, as published by the Free Software Foundation.
17*cdf0e10cSrcweir *
18*cdf0e10cSrcweir * OpenOffice.org is distributed in the hope that it will be useful,
19*cdf0e10cSrcweir * but WITHOUT ANY WARRANTY; without even the implied warranty of
20*cdf0e10cSrcweir * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
21*cdf0e10cSrcweir * GNU Lesser General Public License version 3 for more details
22*cdf0e10cSrcweir * (a copy is included in the LICENSE file that accompanied this code).
23*cdf0e10cSrcweir *
24*cdf0e10cSrcweir * You should have received a copy of the GNU Lesser General Public License
25*cdf0e10cSrcweir * version 3 along with OpenOffice.org.  If not, see
26*cdf0e10cSrcweir * <http://www.openoffice.org/license.html>
27*cdf0e10cSrcweir * for a copy of the LGPLv3 License.
28*cdf0e10cSrcweir *
29*cdf0e10cSrcweir ************************************************************************/
30*cdf0e10cSrcweir
31*cdf0e10cSrcweir#ifndef __com_sun_star_sdb_tools_XIndexAlteration_idl__
32*cdf0e10cSrcweir#define __com_sun_star_sdb_tools_XIndexAlteration_idl__
33*cdf0e10cSrcweir
34*cdf0e10cSrcweir#ifndef __com_sun_star_sdbc_SQLException_idl__
35*cdf0e10cSrcweir#include <com/sun/star/sdbc/SQLException.idl>
36*cdf0e10cSrcweir#endif
37*cdf0e10cSrcweir#include <com/sun/star/sdb/tools/XConnectionSupplier.idl>
38*cdf0e10cSrcweir#ifndef __com_sun_star_lang_XInitialization_idl__
39*cdf0e10cSrcweir#include <com/sun/star/lang/XInitialization.idl>
40*cdf0e10cSrcweir#endif
41*cdf0e10cSrcweir#ifndef __com_sun_star_beans_XPropertySet_idl__
42*cdf0e10cSrcweir#include <com/sun/star/beans/XPropertySet.idl>
43*cdf0e10cSrcweir#endif
44*cdf0e10cSrcweir
45*cdf0e10cSrcweir//=============================================================================
46*cdf0e10cSrcweirmodule com {  module sun {  module star {  module sdb { module tools {
47*cdf0e10cSrcweir//=============================================================================
48*cdf0e10cSrcweir
49*cdf0e10cSrcweir//-----------------------------------------------------------------------------
50*cdf0e10cSrcweir/** allows to alter the indexes of a table.
51*cdf0e10cSrcweir
52*cdf0e10cSrcweir    @see com::sun::star::sdb::DataSource::Settings
53*cdf0e10cSrcweir    @see com::sun::star::sdbcx::XAppend
54*cdf0e10cSrcweir    @see com::sun::star::sdbcx::XDrop
55*cdf0e10cSrcweir
56*cdf0e10cSrcweir    @since OOo 3.3
57*cdf0e10cSrcweir*/
58*cdf0e10cSrcweirinterface XIndexAlteration
59*cdf0e10cSrcweir{
60*cdf0e10cSrcweir    interface XConnectionSupplier;
61*cdf0e10cSrcweir
62*cdf0e10cSrcweir    /** drops an object of the related container identified by its name.
63*cdf0e10cSrcweir        @param table
64*cdf0e10cSrcweir            the table to be altered
65*cdf0e10cSrcweir		@param index
66*cdf0e10cSrcweir			the name of the column to be dropped
67*cdf0e10cSrcweir		@throws com::sun::star::sdbc::SQLException
68*cdf0e10cSrcweir			if a database access error occurs.
69*cdf0e10cSrcweir	 */
70*cdf0e10cSrcweir	void dropIndex([in] com::sun::star::beans::XPropertySet table,[in] string index)
71*cdf0e10cSrcweir	    raises ( com::sun::star::sdbc::SQLException);
72*cdf0e10cSrcweir
73*cdf0e10cSrcweir    /** creates a new object using the given descriptor and appends it
74*cdf0e10cSrcweir		to the related container.
75*cdf0e10cSrcweir		<b>
76*cdf0e10cSrcweir		Note:
77*cdf0e10cSrcweir		</b>
78*cdf0e10cSrcweir		The descriptor will not be changed and can be used again to append another object.
79*cdf0e10cSrcweir        @param table
80*cdf0e10cSrcweir            the table to be altered
81*cdf0e10cSrcweir		@param descriptor
82*cdf0e10cSrcweir			the descriptor which should be serve to append a new object
83*cdf0e10cSrcweir		@throws com::sun::star::sdbc::SQLException
84*cdf0e10cSrcweir			if a database access error occurs.
85*cdf0e10cSrcweir	 */
86*cdf0e10cSrcweir	void addIndex([in] com::sun::star::beans::XPropertySet table,[in]com::sun::star::beans::XPropertySet descriptor)
87*cdf0e10cSrcweir		raises (com::sun::star::sdbc::SQLException);
88*cdf0e10cSrcweir
89*cdf0e10cSrcweir
90*cdf0e10cSrcweir};
91*cdf0e10cSrcweir//=============================================================================
92*cdf0e10cSrcweir}; }; }; }; };
93*cdf0e10cSrcweir//=============================================================================
94*cdf0e10cSrcweir
95*cdf0e10cSrcweir#endif
96*cdf0e10cSrcweir
97