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