/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: Key.idl,v $
 *
 *  $Revision: 1.10 $
 *
 *  last change: $Author: rt $ $Date: 2005-09-08 04:00:03 $
 *
 *  The Contents of this file are made available subject to
 *  the terms of GNU Lesser General Public License Version 2.1.
 *
 *
 *    GNU Lesser General Public License Version 2.1
 *    =============================================
 *    Copyright 2005 by Sun Microsystems, Inc.
 *    901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License version 2.1, as published by the Free Software Foundation.
 *
 *    This library is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *    Lesser General Public License for more details.
 *
 *    You should have received a copy of the GNU Lesser General Public
 *    License along with this library; if not, write to the Free Software
 *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *    MA  02111-1307  USA
 *
 ************************************************************************/
#ifndef __com_sun_star_sdbcx_Key_idl__
#define __com_sun_star_sdbcx_Key_idl__

#ifndef __com_sun_star_beans_XPropertySet_idl__
#include <com/sun/star/beans/XPropertySet.idl>
#endif

 module com {  module sun {  module star {  module sdbcx {

 published interface XColumnsSupplier;
 published interface XDataDescriptorFactory;


// DocMerge from xml: service com::sun::star::sdbcx::Key
/** is used to define a new key for a table.
 */
published service Key
{

    // DocMerge from xml: service com::sun::star::sdbcx::Key: interface com::sun::star::sdbcx::XDataDescriptorFactory
    /** optional, could be used to copy a key.
     */
    [optional] interface XDataDescriptorFactory;


    // DocMerge from xml: service com::sun::star::sdbcx::Key: interface com::sun::star::sdbcx::XColumnsSupplier
    /** access to the contained key columns.
     */
    interface XColumnsSupplier;

    // gives access to the properties.
    interface com::sun::star::beans::XPropertySet;


    // DocMerge from idl: property com::sun::star::sdbcx::Key::Name
    /** is the name of the key
     */
    [readonly, property] string Name;


    // DocMerge from xml: property com::sun::star::sdbcx::Key::Type
    /** indicates the type of the key.
        @see com::sun::star::sdbcx::KeyType
     */
    [readonly, property] long Type;


    // DocMerge from xml: property com::sun::star::sdbcx::Key::ReferencedTable
    /** is the name of the referenced table, only used for foreign
        keys.
     */
    [readonly, property] string ReferencedTable;


    // DocMerge from xml: property com::sun::star::sdbcx::Key::UpdateRule
    /** is the rule which is applied for updates; only used for foreign keys.
        @see com::sun::star::sdbc::KeyRule
     */
    [readonly, property] long UpdateRule;


    // DocMerge from xml: property com::sun::star::sdbcx::Key::DeleteRule
    /** is the rule which is applied for deletions; only used for foreign keys.
        @see com::sun::star::sdbc::KeyRule
     */
    [readonly, property] long DeleteRule;
};

//=============================================================================

}; }; }; };

/*===========================================================================
===========================================================================*/
#endif
