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