xref: /trunk/main/offapi/com/sun/star/sdbcx/Descriptor.idl (revision a893be29)
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_Descriptor_idl__
24#define __com_sun_star_sdbcx_Descriptor_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
32
33/** is used to create a new object within a database.
34
35	<p>
36	A descriptor is commonly created by the container of a specific object, such as, tables or views.
37	After the creation of the descriptor the properties have to be filled.
38	Afterwards, you append the descriptor to the container and the container creates a new object based
39	on the informations of the descriptor. The descriptor can be used to create serveral objects.
40	</p>
41	<p>
42	A descriptor contains at least the informations of the name of an object.
43	</p>
44	@see com::sun::star::sdbcx::XAppend
45 */
46published service Descriptor
47{
48	// gives access to the properties.
49	interface com::sun::star::beans::XPropertySet;
50
51
52	/** is the name for the object to create.
53	 */
54	[property] string Name;
55};
56
57//=============================================================================
58
59}; }; }; };
60
61/*===========================================================================
62===========================================================================*/
63#endif
64