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