xref: /aoo41x/main/offapi/com/sun/star/sdbcx/XDrop.idl (revision d1766043)
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#ifndef __com_sun_star_sdbcx_XDrop_idl__
24#define __com_sun_star_sdbcx_XDrop_idl__
25
26#ifndef __com_sun_star_uno_XInterface_idl__
27#include <com/sun/star/uno/XInterface.idl>
28#endif
29
30#ifndef __com_sun_star_sdbc_SQLException_idl__
31#include <com/sun/star/sdbc/SQLException.idl>
32#endif
33
34#ifndef __com_sun_star_container_NoSuchElementException_idl__
35#include <com/sun/star/container/NoSuchElementException.idl>
36#endif
37
38#ifndef __com_sun_star_lang_IndexOutOfBoundsException_idl__
39#include <com/sun/star/lang/IndexOutOfBoundsException.idl>
40#endif
41
42 module com {  module sun {  module star {  module sdbcx {
43
44/** provides methods to remove an element of its container and to drop it from
45	the related database.
46 */
47published interface XDrop: com::sun::star::uno::XInterface
48{
49
50	/** drops an object of the related container identified by its name.
51		@param elementName
52			the name of the element to be dropped
53		@throws com::sun::star::sdbc::SQLException
54			if a database access error occurs.
55	 */
56	void dropByName([in]string elementName) raises
57	(com::sun::star::sdbc::SQLException,
58		com::sun::star::container::NoSuchElementException);
59	//-------------------------------------------------------------------------
60
61	/** drops an object of the related container identified by its position.
62		@param index
63			the position of the element to be dropped
64		@throws com::sun::star::sdbc::SQLException
65			if a database access error occurs.
66	 */
67	void dropByIndex([in]long index) raises (com::sun::star::sdbc::SQLException,
68		com::sun::star::lang::IndexOutOfBoundsException);
69};
70
71//=============================================================================
72
73}; }; }; };
74
75/*===========================================================================
76===========================================================================*/
77#endif
78