offapi/com/sun/star/sdbcx/View.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 sdbcx {
  21
  22 published interface XRename;
  23 published interface XAlterView;
  24
  25
  26 /** is used to specify views on data. A view object is only used for creation and
  27     deletion. Inspecting the command of a view is normally not supported.
  28
  29     <p>
  30     If a view is going to be added to a database, the view must have a unique
  31     name within the view and the table container, as it can be used like a table.
  32     <b>
  33     Note:
  34     </b>
  35     After addition, both the containers for views and the container for tables must
  36     contain an element for the view.
  37     </p>
  38  */
  39 published service View
  40 {
  41
  42     /** is optional for implementation.
  43      */
  44     [optional] interface XRename;
  45
  46     // gives access to the properties.
  47     interface com::sun::star::beans::XPropertySet;
  48
  49     /** allows changing the view's #Command.
  50     */
  51     [optional] interface XAlterView;
  52
  53
  54     /** is the name of the view.
  55      */
  56     [readonly, property] string Name;
  57
  58
  59     /** is the name of the views catalog, may be empty.
  60      */
  61     [readonly, property] string CatalogName;
  62
  63
  64     /** is the name of the view's schema, may be empty.
  65      */
  66     [readonly, property] string SchemaName;
  67
  68
  69     /** is the command for creating the view.
  70
  71         <p>This is typically a SQL Select-Statement.</p>
  72
  73         <p>This property might be empty when a backend does not support retrieving the current
  74         SQL command of a view. However, if the <code>View</code> supports altering its command
  75         via the #XAlterView interface, then it's required to also provide the
  76         current SQL command in the <code>Command</code> property.</p>
  77      */
  78     [readonly, property] string Command;
  79
  80
  81     /** indicates if a check option should be used for the view.
  82
  83         @see com::sun::star::sdbcx::CheckOption
  84      */
  85     [readonly, property] long CheckOption;
  86 };
  87
  88
  89 }; }; }; };
  90
  91 /*===========================================================================
  92 ===========================================================================*/
  93
  94 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */