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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_sdbcx_Key_idl__
  20 #define __com_sun_star_sdbcx_Key_idl__
  21
  22 #include <com/sun/star/beans/XPropertySet.idl>
  23
  24  module com {  module sun {  module star {  module sdbcx {
  25
  26  published interface XColumnsSupplier;
  27  published interface XDataDescriptorFactory;
  28
  29
  30 /** is used to define a new key for a table.
  31  */
  32 published service Key
  33 {
  34
  35     /** optional, could be used to copy a key.
  36      */
  37     [optional] interface XDataDescriptorFactory;
  38
  39
  40     /** access to the contained key columns.
  41      */
  42     interface XColumnsSupplier;
  43
  44     // gives access to the properties.
  45     interface com::sun::star::beans::XPropertySet;
  46
  47
  48     /** is the name of the key
  49      */
  50     [readonly, property] string Name;
  51
  52
  53     /** indicates the type of the key.
  54         @see com::sun::star::sdbcx::KeyType
  55      */
  56     [readonly, property] long Type;
  57
  58
  59     /** is the name of the referenced table, only used for foreign
  60         keys.
  61      */
  62     [readonly, property] string ReferencedTable;
  63
  64
  65     /** is the rule which is applied for updates; only used for foreign keys.
  66         @see com::sun::star::sdbc::KeyRule
  67      */
  68     [readonly, property] long UpdateRule;
  69
  70
  71     /** is the rule which is applied for deletions; only used for foreign keys.
  72         @see com::sun::star::sdbc::KeyRule
  73      */
  74     [readonly, property] long DeleteRule;
  75 };
  76
  77
  78 }; }; }; };
  79
  80 /*===========================================================================
  81 ===========================================================================*/
  82 #endif
  83
  84 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */