summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/sdbcx/XAlterTable.idl
blob: 971cd2a0df6a9f7075eaa18b2ef75b07af9131c3 (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
66
67
68
69
70
71
72
73
74
75
76
77
78
/* -*- 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_XAlterTable_idl__
#define __com_sun_star_sdbcx_XAlterTable_idl__

#include <com/sun/star/uno/XInterface.idl>
#include <com/sun/star/container/NoSuchElementException.idl>
#include <com/sun/star/lang/IndexOutOfBoundsException.idl>

 module com {  module sun {  module star {  module beans {
 published interface XPropertySet;
};};};};
#include <com/sun/star/sdbc/SQLException.idl>

 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

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