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_KeyDescriptor_idl__
24#define __com_sun_star_sdbcx_KeyDescriptor_idl__
25
26#ifndef __com_sun_star_sdbcx_Descriptor_idl__
27#include <com/sun/star/sdbcx/Descriptor.idl>
28#endif
29
30module com { module sun { module star { module sdbcx {
31
32 published interface XColumnsSupplier;
33
34/**
35 is used to define a new key for a table.
36
37 @see com::sun::star::sdbcx::Key
38 */
39published service KeyDescriptor
40{
41	service Descriptor;
42
43	/** access to the contained key columns.
44	*/
45	interface XColumnsSupplier;
46
47	/** indicates the type of the key.
48		@see com::sun::star::sdbcx::KeyType
49	 */
50	[property] long Type;
51
52	/** is the name of the referenced table, only used for foreign keys.
53	*/
54	[property] string ReferencedTable;
55
56	/** is the rule which is applied for updates; only used for foreign keys.
57		@see com::sun::star::sdbc::KeyRule
58	 */
59	[property] long UpdateRule;
60
61	/** is the rule which is applied for deletions; only used for foreign keys.
62		@see com::sun::star::sdbc::KeyRule
63	*/
64	[property] long DeleteRule;
65};
66
67//=============================================================================
68
69}; }; }; };
70
71#endif
72