xref: /aoo41x/main/offapi/com/sun/star/sdbcx/XAlterTable.idl (revision cdf0e10c)

/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_sdbcx_XAlterTable_idl__
#define __com_sun_star_sdbcx_XAlterTable_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

#ifndef __com_sun_star_container_NoSuchElementException_idl__
#include <com/sun/star/container/NoSuchElementException.idl>
#endif

#ifndef __com_sun_star_lang_IndexOutOfBoundsException_idl__
#include <com/sun/star/lang/IndexOutOfBoundsException.idl>
#endif

 module com {  module sun {  module star {  module beans {
 published interface XPropertySet;
};};};};

#ifndef __com_sun_star_sdbc_SQLException_idl__
#include <com/sun/star/sdbc/SQLException.idl>
#endif

 module com {  module sun {  module star {  module sdbcx {

/** is used for creating and appending new objects to a specific container.
 */
published interface XAlterTable: com::sun::star::uno::XInterface
{

	/** is intended to alter an existing column identified by its name.
		This operation must be atomic, in that it is done in one step.s

        @param colName
			the column name which to alter
		@param descriptor
			the new descriptor for the new column
		@throws com::sun::star::sdbc::SQLException
			if a database access error occurs.
	*/
	void alterColumnByName([in]string colName,
		[in]com::sun::star::beans::XPropertySet descriptor)
		raises (com::sun::star::sdbc::SQLException,
				com::sun::star::container::NoSuchElementException);
	//-------------------------------------------------------------------------

	/** is intended to alter an existing column identified by its position.
		This operation must be atomic, in that it is done in one step.s

        @param index
			the position of the column to alter
		@param descriptor
			the new descriptor for the new column
		@throws com::sun::star::sdbc::SQLException
			if a database access error occurs.
		@throws com::sun::star::lang::IndexOutOfBoundsException
			if the given index does not denote an existing column.
	*/
	void alterColumnByIndex([in]long index,
		[in]com::sun::star::beans::XPropertySet descriptor) raises
		(com::sun::star::sdbc::SQLException,
	 	 com::sun::star::lang::IndexOutOfBoundsException);
};

//=============================================================================

}; }; }; };

/*===========================================================================
===========================================================================*/
#endif