offapi/com/sun/star/sdbcx/View.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: View.idl,v $
  10  * $Revision: 1.11 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_sdbcx_View_idl__
  31 #define __com_sun_star_sdbcx_View_idl__
  32
  33 #ifndef __com_sun_star_beans_XPropertySet_idl__
  34 #include <com/sun/star/beans/XPropertySet.idl>
  35 #endif
  36
  37  module com {  module sun {  module star {  module sdbcx {
  38
  39 published interface XRename;
  40 published interface XAlterView;
  41
  42
  43 /** is used to specify views on data. A view object is only used for creation and
  44     deletion. Inspecting the command of a view is normally not supported.
  45
  46     <p>
  47     If a view is going to be added to a database, the view must have a unique
  48     name within the view and the table container, as it can be used like a table.
  49     <b>
  50     Note:
  51     </b>
  52     After addition, both the containers for views and the container for tables must
  53     contain an element for the view.
  54     </p>
  55  */
  56 published service View
  57 {
  58
  59     /** is optional for implementation.
  60      */
  61     [optional] interface XRename;
  62
  63     // gives access to the properties.
  64     interface com::sun::star::beans::XPropertySet;
  65
  66     /** allows changing the view's <member>Command</member>.
  67     */
  68     [optional] interface XAlterView;
  69
  70
  71     /** is the name of the view.
  72      */
  73     [readonly, property] string Name;
  74
  75
  76     /** is the name of the views catalog, may be empty.
  77      */
  78     [readonly, property] string CatalogName;
  79
  80
  81     /** is the name of the view's schema, may be empty.
  82      */
  83     [readonly, property] string SchemaName;
  84
  85
  86     /** is the command for creating the view.
  87
  88         <p>This is typically a SQL Select-Statement.</p>
  89
  90         <p>This property might be empty when a backend does not support retrieving the current
  91         SQL command of a view. However, if the <code>View</code> supports altering its command
  92         via the <member>XAlterView</member> interface, then it's required to also provide the
  93         current SQL command in the <code>Command</code> property.</p>
  94      */
  95     [readonly, property] string Command;
  96
  97
  98     /** indicates if a check option should be used for the view.
  99
 100         @see com::sun::star::sdbcx::CheckOption
 101      */
 102     [readonly, property] long CheckOption;
 103 };
 104
 105 //=============================================================================
 106
 107 }; }; }; };
 108
 109 /*===========================================================================
 110 ===========================================================================*/
 111 #endif