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
24#ifndef __com_sun_star_text_fieldmaster_Database_idl_
25#define __com_sun_star_text_fieldmaster_Database_idl_
26
27#include <com/sun/star/text/TextFieldMaster.idl>
28#include <com/sun/star/beans/PropertyValues.idl>
29
30//=============================================================================
31
32module com { module sun { module star { module text { module fieldmaster {
33
34//=============================================================================
35/** specifies service of a Database field master.
36	@see com::sun::star::text::TextField
37
38    Only one of the properties <member>DataBaseName</member>,
39    <member>DataBaseURL</member> and <member>DataBaseResource</member>
40    should be set. If more than one are set the last one will be used.
41*/
42published service Database
43{
44	service  com::sun::star::text::TextFieldMaster;
45
46    //------------------------------------------------------------------------
47    /** specifies the database name.
48     */
49    [property] string DataBaseName;
50
51    //------------------------------------------------------------------------
52    /** contains the CommandType this
53     can be the name of a data base table, a data query or a statement.
54     (0 = table, 1 = query, 2 = statement)
55	 */
56    [property] long CommandType;
57    //------------------------------------------------------------------------
58    /** contains the command string. Depending on the CommandType property this
59     can be the name of a data base table, a data query or a statement.
60	 */
61    [property] string DataTableName;
62    //------------------------------------------------------------------------
63    /** contains the name of the data base table.
64	 */
65    [property] string DataColumnName;
66
67    //------------------------------------------------------------------------
68    /** indicates the URL of a database file.
69        @since OpenOffice 2.0
70     */
71    [optional, property] string DataBaseURL;
72
73    //------------------------------------------------------------------------
74    /** indicates a connection URL, which locates a database driver.
75        @since OpenOffice 2.0
76     */
77    [optional, property] string DataBaseResource;
78    //------------------------------------------------------------------------
79    /** contains the DataColumnName but it enables the fieldmaster and its
80        depending fields to work without setting DataSourceName, DataTableName and CommandType
81        @since OpenOffice 2.3
82     */
83    [optional, property] string Name;
84
85};
86
87//=============================================================================
88
89}; }; }; }; };
90
91#endif
92
93