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