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
  20  module com {  module sun {  module star {  module sdbcx {
  21
  22  published interface XColumnsSupplier;
  23  published interface XDataDescriptorFactory;
  24
  25
  26 /** is used to define a new key for a table.
  27  */
  28 published service Key
  29 {
  30
  31     /** optional, could be used to copy a key.
  32      */
  33     [optional] interface XDataDescriptorFactory;
  34
  35
  36     /** access to the contained key columns.
  37      */
  38     interface XColumnsSupplier;
  39
  40     // gives access to the properties.
  41     interface com::sun::star::beans::XPropertySet;
  42
  43
  44     /** is the name of the key
  45      */
  46     [readonly, property] string Name;
  47
  48
  49     /** indicates the type of the key.
  50         @see com::sun::star::sdbcx::KeyType
  51      */
  52     [readonly, property] long Type;
  53
  54
  55     /** is the name of the referenced table, only used for foreign
  56         keys.
  57      */
  58     [readonly, property] string ReferencedTable;
  59
  60
  61     /** is the rule which is applied for updates; only used for foreign keys.
  62         @see com::sun::star::sdbc::KeyRule
  63      */
  64     [readonly, property] long UpdateRule;
  65
  66
  67     /** is the rule which is applied for deletions; only used for foreign keys.
  68         @see com::sun::star::sdbc::KeyRule
  69      */
  70     [readonly, property] long DeleteRule;
  71 };
  72
  73
  74 }; }; }; };
  75
  76 /*===========================================================================
  77 ===========================================================================*/
  78
  79 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */