xref: /aoo41x/main/offapi/com/sun/star/sdbcx/Key.idl (revision d1766043)
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_Key_idl__
24#define __com_sun_star_sdbcx_Key_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 published interface XColumnsSupplier;
33 published interface XDataDescriptorFactory;
34
35
36/** is used to define a new key for a table.
37 */
38published service Key
39{
40
41	/** optional, could be used to copy a key.
42	 */
43	[optional] interface XDataDescriptorFactory;
44
45
46	/** access to the contained key columns.
47	 */
48	interface XColumnsSupplier;
49
50	// gives access to the properties.
51	interface com::sun::star::beans::XPropertySet;
52
53
54	/** is the name of the key
55	 */
56	[readonly, property] string Name;
57
58
59	/** indicates the type of the key.
60		@see com::sun::star::sdbcx::KeyType
61	 */
62	[readonly, property] long Type;
63
64
65	/** is the name of the referenced table, only used for foreign
66		keys.
67	 */
68	[readonly, property] string ReferencedTable;
69
70
71	/** is the rule which is applied for updates; only used for foreign keys.
72		@see com::sun::star::sdbc::KeyRule
73	 */
74	[readonly, property] long UpdateRule;
75
76
77	/** is the rule which is applied for deletions; only used for foreign keys.
78		@see com::sun::star::sdbc::KeyRule
79	 */
80	[readonly, property] long DeleteRule;
81};
82
83//=============================================================================
84
85}; }; }; };
86
87/*===========================================================================
88===========================================================================*/
89#endif
90