1*b1cdbd2cSJim Jagielski/************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_sdbc_KeyRule_idl__ 24*b1cdbd2cSJim Jagielski#define __com_sun_star_sdbc_KeyRule_idl__ 25*b1cdbd2cSJim Jagielski 26*b1cdbd2cSJim Jagielski module com { module sun { module star { module sdbc { 27*b1cdbd2cSJim Jagielski 28*b1cdbd2cSJim Jagielski 29*b1cdbd2cSJim Jagielski/** determines the rules for foreign key constraints. 30*b1cdbd2cSJim Jagielski */ 31*b1cdbd2cSJim Jagielskipublished constants KeyRule 32*b1cdbd2cSJim Jagielski{ 33*b1cdbd2cSJim Jagielski 34*b1cdbd2cSJim Jagielski /** a possible value for the column's 35*b1cdbd2cSJim Jagielski <code>UPDATE_RULE</code> 36*b1cdbd2cSJim Jagielski and 37*b1cdbd2cSJim Jagielski <code>DELETE_RULE</code> 38*b1cdbd2cSJim Jagielski in the 39*b1cdbd2cSJim Jagielski <type scope="com::sun::star::sdbc">XResultSet</type> 40*b1cdbd2cSJim Jagielski objects returned by the methods 41*b1cdbd2cSJim Jagielski <member scope="com::sun::star::sdbc">XDatabaseMetaData::getImportedKeys()</member> 42*b1cdbd2cSJim Jagielski , 43*b1cdbd2cSJim Jagielski <member scope="com::sun::star::sdbc">XDatabaseMetaData::getExportedKeys()</member> 44*b1cdbd2cSJim Jagielski , 45*b1cdbd2cSJim Jagielski and 46*b1cdbd2cSJim Jagielski <member scope="com::sun::star::sdbc">XDatabaseMetaData::getCrossReference()</member> 47*b1cdbd2cSJim Jagielski . 48*b1cdbd2cSJim Jagielski <P> 49*b1cdbd2cSJim Jagielski For the column 50*b1cdbd2cSJim Jagielski <code>UPDATE_RULE</code> 51*b1cdbd2cSJim Jagielski , 52*b1cdbd2cSJim Jagielski it indicates that 53*b1cdbd2cSJim Jagielski when the primary key is updated, the foreign key (imported key) 54*b1cdbd2cSJim Jagielski is changed to agree with it. 55*b1cdbd2cSJim Jagielski </P> 56*b1cdbd2cSJim Jagielski <P> 57*b1cdbd2cSJim Jagielski For the column 58*b1cdbd2cSJim Jagielski <code>DELETE_RULE</code> 59*b1cdbd2cSJim Jagielski , 60*b1cdbd2cSJim Jagielski it indicates that 61*b1cdbd2cSJim Jagielski when the primary key is deleted, rows that imported that key 62*b1cdbd2cSJim Jagielski are deleted. 63*b1cdbd2cSJim Jagielski </P> 64*b1cdbd2cSJim Jagielski */ 65*b1cdbd2cSJim Jagielski const long CASCADE = 0; 66*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 67*b1cdbd2cSJim Jagielski 68*b1cdbd2cSJim Jagielski /** a possible value for the column's 69*b1cdbd2cSJim Jagielski <code>UPDATE_RULE</code> 70*b1cdbd2cSJim Jagielski and 71*b1cdbd2cSJim Jagielski <code>DELETE_RULE</code> 72*b1cdbd2cSJim Jagielski in the 73*b1cdbd2cSJim Jagielski <type scope="com::sun::star::sdbc">XResultSet</type> 74*b1cdbd2cSJim Jagielski objects returned by the methods 75*b1cdbd2cSJim Jagielski <member scope="com::sun::star::sdbc">XDatabaseMetaData::getImportedKeys()</member> 76*b1cdbd2cSJim Jagielski , 77*b1cdbd2cSJim Jagielski <member scope="com::sun::star::sdbc">XDatabaseMetaData::getExportedKeys()</member> 78*b1cdbd2cSJim Jagielski , 79*b1cdbd2cSJim Jagielski and 80*b1cdbd2cSJim Jagielski <member scope="com::sun::star::sdbc">XDatabaseMetaData::getCrossReference()</member> 81*b1cdbd2cSJim Jagielski . 82*b1cdbd2cSJim Jagielski <P> 83*b1cdbd2cSJim Jagielski For the column 84*b1cdbd2cSJim Jagielski <code>UPDATE_RULE</code> 85*b1cdbd2cSJim Jagielski , it indicates that 86*b1cdbd2cSJim Jagielski a primary key may not be updated if it has been imported by 87*b1cdbd2cSJim Jagielski another table as a foreign key. 88*b1cdbd2cSJim Jagielski </P> 89*b1cdbd2cSJim Jagielski <P> 90*b1cdbd2cSJim Jagielski For the column 91*b1cdbd2cSJim Jagielski <code>DELETE_RULE</code> 92*b1cdbd2cSJim Jagielski , it indicates that 93*b1cdbd2cSJim Jagielski a primary key may not be deleted if it has been imported by 94*b1cdbd2cSJim Jagielski another table as a foreign key. 95*b1cdbd2cSJim Jagielski </P> 96*b1cdbd2cSJim Jagielski */ 97*b1cdbd2cSJim Jagielski const long RESTRICT = 1; 98*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 99*b1cdbd2cSJim Jagielski 100*b1cdbd2cSJim Jagielski /** a possible value for the column's 101*b1cdbd2cSJim Jagielski <code>UPDATE_RULE</code> 102*b1cdbd2cSJim Jagielski and 103*b1cdbd2cSJim Jagielski <code>DELETE_RULE</code> 104*b1cdbd2cSJim Jagielski in the 105*b1cdbd2cSJim Jagielski <type scope="com::sun::star::sdbc">XResultSet</type> 106*b1cdbd2cSJim Jagielski objects returned by the methods 107*b1cdbd2cSJim Jagielski <member scope="com::sun::star::sdbc">XDatabaseMetaData::getImportedKeys()</member> 108*b1cdbd2cSJim Jagielski , 109*b1cdbd2cSJim Jagielski <member scope="com::sun::star::sdbc">XDatabaseMetaData::getExportedKeys()</member> 110*b1cdbd2cSJim Jagielski , 111*b1cdbd2cSJim Jagielski and 112*b1cdbd2cSJim Jagielski <member scope="com::sun::star::sdbc">XDatabaseMetaData::getCrossReference()</member> 113*b1cdbd2cSJim Jagielski . 114*b1cdbd2cSJim Jagielski <P> 115*b1cdbd2cSJim Jagielski For the columns 116*b1cdbd2cSJim Jagielski <code>UPDATE_RULE</code> 117*b1cdbd2cSJim Jagielski and 118*b1cdbd2cSJim Jagielski <code>DELETE_RULE</code> 119*b1cdbd2cSJim Jagielski , 120*b1cdbd2cSJim Jagielski it indicates that 121*b1cdbd2cSJim Jagielski when the primary key is updated or deleted, the foreign key (imported key) 122*b1cdbd2cSJim Jagielski is changed to <code>NULL</code>. 123*b1cdbd2cSJim Jagielski </P> 124*b1cdbd2cSJim Jagielski */ 125*b1cdbd2cSJim Jagielski const long SET_NULL = 2; 126*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 127*b1cdbd2cSJim Jagielski 128*b1cdbd2cSJim Jagielski /** a possible value for the column's 129*b1cdbd2cSJim Jagielski <code>UPDATE_RULE</code> 130*b1cdbd2cSJim Jagielski and 131*b1cdbd2cSJim Jagielski <code>DELETE_RULE</code> 132*b1cdbd2cSJim Jagielski in the 133*b1cdbd2cSJim Jagielski <type scope="com::sun::star::sdbc">XResultSet</type> 134*b1cdbd2cSJim Jagielski objects returned by the methods 135*b1cdbd2cSJim Jagielski <member scope="com::sun::star::sdbc">XDatabaseMetaData::getImportedKeys()</member> 136*b1cdbd2cSJim Jagielski , 137*b1cdbd2cSJim Jagielski <member scope="com::sun::star::sdbc">XDatabaseMetaData::getExportedKeys()</member> 138*b1cdbd2cSJim Jagielski , 139*b1cdbd2cSJim Jagielski and 140*b1cdbd2cSJim Jagielski <member scope="com::sun::star::sdbc">XDatabaseMetaData::getCrossReference()</member> 141*b1cdbd2cSJim Jagielski . 142*b1cdbd2cSJim Jagielski <P> 143*b1cdbd2cSJim Jagielski For the columns 144*b1cdbd2cSJim Jagielski <code>UPDATE_RULE</code> 145*b1cdbd2cSJim Jagielski and 146*b1cdbd2cSJim Jagielski <code>DELETE_RULE</code> 147*b1cdbd2cSJim Jagielski , 148*b1cdbd2cSJim Jagielski it indicates that if the primary key has been imported, it cannot be updated or deleted. 149*b1cdbd2cSJim Jagielski </P> 150*b1cdbd2cSJim Jagielski */ 151*b1cdbd2cSJim Jagielski const long NO_ACTION = 3; 152*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 153*b1cdbd2cSJim Jagielski 154*b1cdbd2cSJim Jagielski /** a possible value for the column's 155*b1cdbd2cSJim Jagielski <code>UPDATE_RULE</code> 156*b1cdbd2cSJim Jagielski and 157*b1cdbd2cSJim Jagielski <code>DELETE_RULE</code> 158*b1cdbd2cSJim Jagielski in the 159*b1cdbd2cSJim Jagielski <type scope="com::sun::star::sdbc">XResultSet</type> 160*b1cdbd2cSJim Jagielski objects returned by the methods 161*b1cdbd2cSJim Jagielski <member scope="com::sun::star::sdbc">XDatabaseMetaData::getImportedKeys()</member> 162*b1cdbd2cSJim Jagielski , 163*b1cdbd2cSJim Jagielski <member scope="com::sun::star::sdbc">XDatabaseMetaData::getExportedKeys()</member> 164*b1cdbd2cSJim Jagielski , 165*b1cdbd2cSJim Jagielski and 166*b1cdbd2cSJim Jagielski <member scope="com::sun::star::sdbc">XDatabaseMetaData::getCrossReference()</member> 167*b1cdbd2cSJim Jagielski . 168*b1cdbd2cSJim Jagielski <P> 169*b1cdbd2cSJim Jagielski For the columns 170*b1cdbd2cSJim Jagielski <code>UPDATE_RULE</code> 171*b1cdbd2cSJim Jagielski and 172*b1cdbd2cSJim Jagielski <code>DELETE_RULE</code> 173*b1cdbd2cSJim Jagielski , 174*b1cdbd2cSJim Jagielski it indicates that 175*b1cdbd2cSJim Jagielski if the primary key is updated or deleted, the foreign key (imported key) 176*b1cdbd2cSJim Jagielski is set to the default value. 177*b1cdbd2cSJim Jagielski </P> 178*b1cdbd2cSJim Jagielski */ 179*b1cdbd2cSJim Jagielski const long SET_DEFAULT = 4; 180*b1cdbd2cSJim Jagielski}; 181*b1cdbd2cSJim Jagielski 182*b1cdbd2cSJim Jagielski//============================================================================= 183*b1cdbd2cSJim Jagielski 184*b1cdbd2cSJim Jagielski}; }; }; }; 185*b1cdbd2cSJim Jagielski 186*b1cdbd2cSJim Jagielski/*=========================================================================== 187*b1cdbd2cSJim Jagielski===========================================================================*/ 188*b1cdbd2cSJim Jagielski#endif 189