xref: /trunk/main/offapi/com/sun/star/sdbcx/Descriptor.idl (revision ffd38472365e95f6a578737bc9a5eb0fac624a86)
1d1766043SAndrew Rist/**************************************************************
2cdf0e10cSrcweir *
3d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one
4d1766043SAndrew Rist * or more contributor license agreements.  See the NOTICE file
5d1766043SAndrew Rist * distributed with this work for additional information
6d1766043SAndrew Rist * regarding copyright ownership.  The ASF licenses this file
7d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the
8d1766043SAndrew Rist * "License"); you may not use this file except in compliance
9d1766043SAndrew Rist * with the License.  You may obtain a copy of the License at
10cdf0e10cSrcweir *
11d1766043SAndrew Rist *   http://www.apache.org/licenses/LICENSE-2.0
12cdf0e10cSrcweir *
13d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing,
14d1766043SAndrew Rist * software distributed under the License is distributed on an
15d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16d1766043SAndrew Rist * KIND, either express or implied.  See the License for the
17d1766043SAndrew Rist * specific language governing permissions and limitations
18d1766043SAndrew Rist * under the License.
19cdf0e10cSrcweir *
20d1766043SAndrew Rist *************************************************************/
21d1766043SAndrew Rist
22d1766043SAndrew Rist
23cdf0e10cSrcweir#ifndef __com_sun_star_sdbcx_Descriptor_idl__
24cdf0e10cSrcweir#define __com_sun_star_sdbcx_Descriptor_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
32cdf0e10cSrcweir
33cdf0e10cSrcweir/** is used to create a new object within a database.
34cdf0e10cSrcweir
35cdf0e10cSrcweir    <p>
36cdf0e10cSrcweir    A descriptor is commonly created by the container of a specific object, such as, tables or views.
37cdf0e10cSrcweir    After the creation of the descriptor the properties have to be filled.
38cdf0e10cSrcweir    Afterwards, you append the descriptor to the container and the container creates a new object based
39*6362920dSJohn Bampton    on the informations of the descriptor. The descriptor can be used to create several objects.
40cdf0e10cSrcweir    </p>
41cdf0e10cSrcweir    <p>
42a893be29SPedro Giffuni    A descriptor contains at least the informations of the name of an object.
43cdf0e10cSrcweir    </p>
44cdf0e10cSrcweir    @see com::sun::star::sdbcx::XAppend
45cdf0e10cSrcweir */
46cdf0e10cSrcweirpublished service Descriptor
47cdf0e10cSrcweir{
48cdf0e10cSrcweir    // gives access to the properties.
49cdf0e10cSrcweir    interface com::sun::star::beans::XPropertySet;
50cdf0e10cSrcweir
51cdf0e10cSrcweir
52cdf0e10cSrcweir    /** is the name for the object to create.
53cdf0e10cSrcweir     */
54cdf0e10cSrcweir    [property] string Name;
55cdf0e10cSrcweir};
56cdf0e10cSrcweir
57cdf0e10cSrcweir//=============================================================================
58cdf0e10cSrcweir
59cdf0e10cSrcweir}; }; }; };
60cdf0e10cSrcweir
61cdf0e10cSrcweir/*===========================================================================
62cdf0e10cSrcweir===========================================================================*/
63cdf0e10cSrcweir#endif
64