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

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