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