summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/sdb/tools/XViewAccess.idl
blob: 5a7b4fb9a87333578cdae80f1f586bd42d9c06b1 (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
/* -*- 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_sdb_tools_XViewAccess_idl__
#define __com_sun_star_sdb_tools_XViewAccess_idl__

#include <com/sun/star/sdbc/SQLException.idl>
#include <com/sun/star/sdb/tools/XConnectionSupplier.idl>
#include <com/sun/star/lang/XInitialization.idl>
#include <com/sun/star/beans/XPropertySet.idl>

module com {  module sun {  module star {  module sdb { module tools {

/** allows to fetch and to change the sql statements of views

    @see com::sun::star::sdb::DataSource::Settings
    @see com::sun::star::sdbcx::View

    @since OOo 3.3
*/
interface XViewAccess
{
    interface XConnectionSupplier;

    /** returns the SQL statement of the view

        @param view
            the table to be renamed
        @throws com::sun::star::sdbc::SQLException
    */
    string getCommand( [in] com::sun::star::beans::XPropertySet view)
        raises ( com::sun::star::sdbc::SQLException );

    /** allows to alter the SQL statement of a view

        @param view
            the view to be altered

        @param command
            the new SQL statement

        @throws com::sun::star::sdbc::SQLException
    */
    void  alterCommand( [in] com::sun::star::beans::XPropertySet view, [in] string command)
        raises ( com::sun::star::sdbc::SQLException );
};
}; }; }; }; };

#endif

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