offapi/com/sun/star/sdb/tools/XViewAccess.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 module com {  module sun {  module star {  module sdb { module tools {
  21
  22 /** allows to fetch and to change the sql statements of views
  23
  24     @see com::sun::star::sdb::DataSource::Settings
  25     @see com::sun::star::sdbcx::View
  26
  27     @since OOo 3.3
  28 */
  29 interface XViewAccess
  30 {
  31     interface XConnectionSupplier;
  32
  33     /** returns the SQL statement of the view
  34
  35         @param view
  36             the table to be renamed
  37         @throws com::sun::star::sdbc::SQLException
  38     */
  39     string getCommand( [in] com::sun::star::beans::XPropertySet view)
  40         raises ( com::sun::star::sdbc::SQLException );
  41
  42     /** allows to alter the SQL statement of a view
  43
  44         @param view
  45             the view to be altered
  46
  47         @param command
  48             the new SQL statement
  49
  50         @throws com::sun::star::sdbc::SQLException
  51     */
  52     void  alterCommand( [in] com::sun::star::beans::XPropertySet view, [in] string command)
  53         raises ( com::sun::star::sdbc::SQLException );
  54 };
  55 }; }; }; }; };
  56
  57 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */