offapi/com/sun/star/sdbcx/KeyDescriptor.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
  24 /**
  25  is used to define a new key for a table.
  26
  27  @see com::sun::star::sdbcx::Key
  28  */
  29 published service KeyDescriptor
  30 {
  31     service Descriptor;
  32
  33     /** access to the contained key columns.
  34     */
  35     interface XColumnsSupplier;
  36
  37     /** indicates the type of the key.
  38         @see com::sun::star::sdbcx::KeyType
  39      */
  40     [property] long Type;
  41
  42     /** is the name of the referenced table, only used for foreign keys.
  43     */
  44     [property] string ReferencedTable;
  45
  46     /** is the rule which is applied for updates; only used for foreign keys.
  47         @see com::sun::star::sdbc::KeyRule
  48      */
  49     [property] long UpdateRule;
  50
  51     /** is the rule which is applied for deletions; only used for foreign keys.
  52         @see com::sun::star::sdbc::KeyRule
  53     */
  54     [property] long DeleteRule;
  55 };
  56
  57
  58 }; }; }; };
  59
  60 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */