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