1*b1cdbd2cSJim Jagielski/************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski 24*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_sdb_tools_XTableAlteration_idl__ 25*b1cdbd2cSJim Jagielski#define __com_sun_star_sdb_tools_XTableAlteration_idl__ 26*b1cdbd2cSJim Jagielski 27*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_sdbc_SQLException_idl__ 28*b1cdbd2cSJim Jagielski#include <com/sun/star/sdbc/SQLException.idl> 29*b1cdbd2cSJim Jagielski#endif 30*b1cdbd2cSJim Jagielski#include <com/sun/star/sdb/tools/XConnectionSupplier.idl> 31*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_lang_XInitialization_idl__ 32*b1cdbd2cSJim Jagielski#include <com/sun/star/lang/XInitialization.idl> 33*b1cdbd2cSJim Jagielski#endif 34*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_beans_XPropertySet_idl__ 35*b1cdbd2cSJim Jagielski#include <com/sun/star/beans/XPropertySet.idl> 36*b1cdbd2cSJim Jagielski#endif 37*b1cdbd2cSJim Jagielski 38*b1cdbd2cSJim Jagielski//============================================================================= 39*b1cdbd2cSJim Jagielskimodule com { module sun { module star { module sdb { module tools { 40*b1cdbd2cSJim Jagielski//============================================================================= 41*b1cdbd2cSJim Jagielski 42*b1cdbd2cSJim Jagielski//----------------------------------------------------------------------------- 43*b1cdbd2cSJim Jagielski/** allows to alter a table. 44*b1cdbd2cSJim Jagielski 45*b1cdbd2cSJim Jagielski @see com::sun::star::sdb::DataSource::Settings 46*b1cdbd2cSJim Jagielski @see com::sun::star::sdbcx::ColumnDescriptor 47*b1cdbd2cSJim Jagielski @see com::sun::star::sdbcx::XAlterTable 48*b1cdbd2cSJim Jagielski @see com::sun::star::sdbcx::XAppend 49*b1cdbd2cSJim Jagielski @see com::sun::star::sdbcx::XDrop 50*b1cdbd2cSJim Jagielski 51*b1cdbd2cSJim Jagielski @since OpenOffice 3.3 52*b1cdbd2cSJim Jagielski*/ 53*b1cdbd2cSJim Jagielskiinterface XTableAlteration 54*b1cdbd2cSJim Jagielski{ 55*b1cdbd2cSJim Jagielski interface XConnectionSupplier; 56*b1cdbd2cSJim Jagielski 57*b1cdbd2cSJim Jagielski /** alter the column defined by name 58*b1cdbd2cSJim Jagielski 59*b1cdbd2cSJim Jagielski @param table 60*b1cdbd2cSJim Jagielski the table to be altered 61*b1cdbd2cSJim Jagielski 62*b1cdbd2cSJim Jagielski @param columnName 63*b1cdbd2cSJim Jagielski the name of the column to be changed 64*b1cdbd2cSJim Jagielski 65*b1cdbd2cSJim Jagielski @param columnDescriptor 66*b1cdbd2cSJim Jagielski the column descriptor with the information of the new column definition 67*b1cdbd2cSJim Jagielski 68*b1cdbd2cSJim Jagielski @throws com::sun::star::sdbc::SQLException 69*b1cdbd2cSJim Jagielski @see com::sun::star::sdbcx::XAlterTable 70*b1cdbd2cSJim Jagielski */ 71*b1cdbd2cSJim Jagielski void alterColumnByName( [in] com::sun::star::beans::XPropertySet table, [in] string columnName, [in] com::sun::star::beans::XPropertySet columnDescriptor) 72*b1cdbd2cSJim Jagielski raises ( com::sun::star::sdbc::SQLException ); 73*b1cdbd2cSJim Jagielski 74*b1cdbd2cSJim Jagielski /** creates a new object using the given descriptor and appends it 75*b1cdbd2cSJim Jagielski to the related container. 76*b1cdbd2cSJim Jagielski <b> 77*b1cdbd2cSJim Jagielski Note: 78*b1cdbd2cSJim Jagielski </b> 79*b1cdbd2cSJim Jagielski The descriptor will not be changed and can be used again to append another object. 80*b1cdbd2cSJim Jagielski @param table 81*b1cdbd2cSJim Jagielski the table to be altered 82*b1cdbd2cSJim Jagielski @param descriptor 83*b1cdbd2cSJim Jagielski the descriptor which should be serve to append a new object 84*b1cdbd2cSJim Jagielski @throws com::sun::star::sdbc::SQLException 85*b1cdbd2cSJim Jagielski if a database access error occurs. 86*b1cdbd2cSJim Jagielski @see com::sun::star::sdbcx::XAppend 87*b1cdbd2cSJim Jagielski */ 88*b1cdbd2cSJim Jagielski void addColumn([in] com::sun::star::beans::XPropertySet table,[in]com::sun::star::beans::XPropertySet descriptor) 89*b1cdbd2cSJim Jagielski raises (com::sun::star::sdbc::SQLException); 90*b1cdbd2cSJim Jagielski 91*b1cdbd2cSJim Jagielski /** drops an object of the related container identified by its name. 92*b1cdbd2cSJim Jagielski @param table 93*b1cdbd2cSJim Jagielski the table to be altered 94*b1cdbd2cSJim Jagielski @param columnName 95*b1cdbd2cSJim Jagielski the name of the column to be dropped 96*b1cdbd2cSJim Jagielski @throws com::sun::star::sdbc::SQLException 97*b1cdbd2cSJim Jagielski if a database access error occurs. 98*b1cdbd2cSJim Jagielski @see com::sun::star::sdbcx::XDrop 99*b1cdbd2cSJim Jagielski */ 100*b1cdbd2cSJim Jagielski void dropColumn([in] com::sun::star::beans::XPropertySet table,[in]string columnName) 101*b1cdbd2cSJim Jagielski raises ( com::sun::star::sdbc::SQLException); 102*b1cdbd2cSJim Jagielski}; 103*b1cdbd2cSJim Jagielski//============================================================================= 104*b1cdbd2cSJim Jagielski}; }; }; }; }; 105*b1cdbd2cSJim Jagielski//============================================================================= 106*b1cdbd2cSJim Jagielski 107*b1cdbd2cSJim Jagielski#endif 108*b1cdbd2cSJim Jagielski 109