summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/sdbcx/XDrop.idl
blob: 143a786cb74b23dbae89c48ebd69b49469a69e63 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */
#ifndef __com_sun_star_sdbcx_XDrop_idl__
#define __com_sun_star_sdbcx_XDrop_idl__

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

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

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

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

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

/** provides methods to remove an element of its container and to drop it from
    the related database.
 */
published interface XDrop: com::sun::star::uno::XInterface
{

    /** drops an object of the related container identified by its name.
        @param elementName
            the name of the element to be dropped
        @throws com::sun::star::sdbc::SQLException
            if a database access error occurs.
     */
    void dropByName([in]string elementName) raises
    (com::sun::star::sdbc::SQLException,
        com::sun::star::container::NoSuchElementException);

    /** drops an object of the related container identified by its position.
        @param index
            the position of the element to be dropped
        @throws com::sun::star::sdbc::SQLException
            if a database access error occurs.
     */
    void dropByIndex([in]long index) raises (com::sun::star::sdbc::SQLException,
        com::sun::star::lang::IndexOutOfBoundsException);
};


}; }; }; };

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

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */