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