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