offapi/com/sun/star/sdbcx/KeyDescriptor.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: KeyDescriptor.idl,v $
  10  * $Revision: 1.10 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_sdbcx_KeyDescriptor_idl__
  31 #define __com_sun_star_sdbcx_KeyDescriptor_idl__
  32
  33 #ifndef __com_sun_star_sdbcx_Descriptor_idl__
  34 #include <com/sun/star/sdbcx/Descriptor.idl>
  35 #endif
  36
  37 module com { module sun { module star { module sdbcx {
  38
  39  published interface XColumnsSupplier;
  40
  41 /**
  42  is used to define a new key for a table.
  43
  44  @see com::sun::star::sdbcx::Key
  45  */
  46 published service KeyDescriptor
  47 {
  48     service Descriptor;
  49
  50     /** access to the contained key columns.
  51     */
  52     interface XColumnsSupplier;
  53
  54     /** indicates the type of the key.
  55         @see com::sun::star::sdbcx::KeyType
  56      */
  57     [property] long Type;
  58
  59     /** is the name of the referenced table, only used for foreign keys.
  60     */
  61     [property] string ReferencedTable;
  62
  63     /** is the rule which is applied for updates; only used for foreign keys.
  64         @see com::sun::star::sdbc::KeyRule
  65      */
  66     [property] long UpdateRule;
  67
  68     /** is the rule which is applied for deletions; only used for foreign keys.
  69         @see com::sun::star::sdbc::KeyRule
  70     */
  71     [property] long DeleteRule;
  72 };
  73
  74 //=============================================================================
  75
  76 }; }; }; };
  77
  78 #endif