xref: /aoo42x/main/offapi/com/sun/star/sdbcx/View.idl (revision d1766043)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_sdbcx_View_idl__
24#define __com_sun_star_sdbcx_View_idl__
25
26#ifndef __com_sun_star_beans_XPropertySet_idl__
27#include <com/sun/star/beans/XPropertySet.idl>
28#endif
29
30 module com {  module sun {  module star {  module sdbcx {
31
32published interface XRename;
33published interface XAlterView;
34
35
36/** is used to specify views on data. A view object is only used for creation and
37	deletion. Inspecting the command of a view is normally not supported.
38
39	<p>
40	If a view is going to be added to a database, the view must have a unique
41	name within the view and the table container, as it can be used like a table.
42	<b>
43	Note:
44	</b>
45	After addition, both the containers for views and the container for tables must
46	contain an element for the view.
47	</p>
48 */
49published service View
50{
51
52	/** is optional for implementation.
53	 */
54	[optional] interface XRename;
55
56	// gives access to the properties.
57	interface com::sun::star::beans::XPropertySet;
58
59    /** allows changing the view's <member>Command</member>.
60    */
61    [optional] interface XAlterView;
62
63
64	/** is the name of the view.
65	 */
66	[readonly, property] string Name;
67
68
69	/** is the name of the views catalog, may be empty.
70	 */
71	[readonly, property] string CatalogName;
72
73
74	/** is the name of the view's schema, may be empty.
75	 */
76	[readonly, property] string SchemaName;
77
78
79	/** is the command for creating the view.
80
81        <p>This is typically a SQL Select-Statement.</p>
82
83        <p>This property might be empty when a backend does not support retrieving the current
84        SQL command of a view. However, if the <code>View</code> supports altering its command
85        via the <member>XAlterView</member> interface, then it's required to also provide the
86        current SQL command in the <code>Command</code> property.</p>
87	 */
88	[readonly, property] string Command;
89
90
91	/** indicates if a check option should be used for the view.
92
93        @see com::sun::star::sdbcx::CheckOption
94	 */
95	[readonly, property] long CheckOption;
96};
97
98//=============================================================================
99
100}; }; }; };
101
102/*===========================================================================
103===========================================================================*/
104#endif
105