libreoffice/offapi/com/sun/star/sdbc/KeyRule.idl

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */

 module com {  module sun {  module star {  module sdbc {


/** determines the rules for foreign key constraints.
 */
published constants KeyRule
{

    /** a possible value for the column's
            <code>UPDATE_RULE</code>
            and
            <code>DELETE_RULE</code>
            in the
            com::sun::star::sdbc::XResultSet
             objects returned by the methods
             com::sun::star::sdbc::XDatabaseMetaData::getImportedKeys(),
             com::sun::star::sdbc::XDatabaseMetaData::getExportedKeys(),
             and com::sun::star::sdbc::XDatabaseMetaData::getCrossReference().
             <P>
             For the column
             <code>UPDATE_RULE</code>
             ,
             it indicates that
             when the primary key is updated, the foreign key (imported key)
             is changed to agree with it.
             </P>
             <P>
             For the column
             <code>DELETE_RULE</code>
            ,
             it indicates that
             when the primary key is deleted, rows that imported that key
             are deleted.
             </P>
     */
    const long CASCADE  = 0;

    /** a possible value for the column's
             <code>UPDATE_RULE</code>
             and
             <code>DELETE_RULE</code>
            in the
             com::sun::star::sdbc::XResultSet
             objects returned by the methods
             com::sun::star::sdbc::XDatabaseMetaData::getImportedKeys(),
             com::sun::star::sdbc::XDatabaseMetaData::getExportedKeys(),
             and com::sun::star::sdbc::XDatabaseMetaData::getCrossReference().
             <P>
             For the column
             <code>UPDATE_RULE</code>
            , it indicates that
             a primary key may not be updated if it has been imported by
             another table as a foreign key.
             </P>
             <P>
             For the column
             <code>DELETE_RULE</code>
            , it indicates that
             a primary key may not be deleted if it has been imported by
             another table as a foreign key.
             </P>
     */
    const long RESTRICT = 1;

    /** a possible value for the column's
             <code>UPDATE_RULE</code>
             and
             <code>DELETE_RULE</code>
            in the
             com::sun::star::sdbc::XResultSet
              objects returned by the methods
            com::sun::star::sdbc::XDatabaseMetaData::getImportedKeys(),
             com::sun::star::sdbc::XDatabaseMetaData::getExportedKeys(),
             and com::sun::star::sdbc::XDatabaseMetaData::getCrossReference().
             <P>
             For the columns
             <code>UPDATE_RULE</code>
             and
             <code>DELETE_RULE</code>
            ,
             it indicates that
             when the primary key is updated or deleted, the foreign key (imported key)
             is changed to <code>NULL</code>.
             </P>
     */
    const long SET_NULL  = 2;

    /** a possible value for the column's
            <code>UPDATE_RULE</code>
             and
             <code>DELETE_RULE</code>
             in the
             com::sun::star::sdbc::XResultSet
             objects returned by the methods
             com::sun::star::sdbc::XDatabaseMetaData::getImportedKeys(),
             com::sun::star::sdbc::XDatabaseMetaData::getExportedKeys(),
             and com::sun::star::sdbc::XDatabaseMetaData::getCrossReference().
             <P>
             For the columns
             <code>UPDATE_RULE</code>
             and
             <code>DELETE_RULE</code>
            ,
             it indicates that if the primary key has been imported, it cannot be updated or deleted.
             </P>
     */
    const long NO_ACTION = 3;

    /** a possible value for the column's
            <code>UPDATE_RULE</code>
             and
             <code>DELETE_RULE</code>
            in the
             com::sun::star::sdbc::XResultSet
             objects returned by the methods
             com::sun::star::sdbc::XDatabaseMetaData::getImportedKeys(),
             com::sun::star::sdbc::XDatabaseMetaData::getExportedKeys(),
             and com::sun::star::sdbc::XDatabaseMetaData::getCrossReference().
             <P>
             For the columns
             <code>UPDATE_RULE</code>
             and
             <code>DELETE_RULE</code>
            ,
             it indicates that
             if the primary key is updated or deleted, the foreign key (imported key)
             is set to the default value.
             </P>
     */
    const long SET_DEFAULT  = 4;
};


}; }; }; };

/*===========================================================================
===========================================================================*/

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */