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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28 #ifndef __com_sun_star_sdbcx_Key_idl__
  29 #define __com_sun_star_sdbcx_Key_idl__
  30
  31 #include <com/sun/star/beans/XPropertySet.idl>
  32
  33  module com {  module sun {  module star {  module sdbcx {
  34
  35  published interface XColumnsSupplier;
  36  published interface XDataDescriptorFactory;
  37
  38
  39 /** is used to define a new key for a table.
  40  */
  41 published service Key
  42 {
  43
  44     /** optional, could be used to copy a key.
  45      */
  46     [optional] interface XDataDescriptorFactory;
  47
  48
  49     /** access to the contained key columns.
  50      */
  51     interface XColumnsSupplier;
  52
  53     // gives access to the properties.
  54     interface com::sun::star::beans::XPropertySet;
  55
  56
  57     /** is the name of the key
  58      */
  59     [readonly, property] string Name;
  60
  61
  62     /** indicates the type of the key.
  63         @see com::sun::star::sdbcx::KeyType
  64      */
  65     [readonly, property] long Type;
  66
  67
  68     /** is the name of the referenced table, only used for foreign
  69         keys.
  70      */
  71     [readonly, property] string ReferencedTable;
  72
  73
  74     /** is the rule which is applied for updates; only used for foreign keys.
  75         @see com::sun::star::sdbc::KeyRule
  76      */
  77     [readonly, property] long UpdateRule;
  78
  79
  80     /** is the rule which is applied for deletions; only used for foreign keys.
  81         @see com::sun::star::sdbc::KeyRule
  82      */
  83     [readonly, property] long DeleteRule;
  84 };
  85
  86 //=============================================================================
  87
  88 }; }; }; };
  89
  90 /*===========================================================================
  91 ===========================================================================*/
  92 #endif
  93
  94 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */