Overview Module Use Devguide Index
Constants Constants' Details

:: com :: sun :: star :: sdbc ::

constants group KeyRule
Description
determines the rules for foreign key constraints.
Constants
CASCADE a possible value for the column's UPDATE_RULE and DELETE_RULE 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() .  
RESTRICT a possible value for the column's UPDATE_RULE and DELETE_RULE 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() .  
SET_NULL a possible value for the column's UPDATE_RULE and DELETE_RULE 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() .  
NO_ACTION a possible value for the column's UPDATE_RULE and DELETE_RULE 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() .  
SET_DEFAULT a possible value for the column's UPDATE_RULE and DELETE_RULE 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() .  
Constants' Details
CASCADE
const long CASCADE = 0;
Description
a possible value for the column's UPDATE_RULE and DELETE_RULE 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() .

For the column UPDATE_RULE , it indicates that when the primary key is updated, the foreign key (imported key) is changed to agree with it.

For the column DELETE_RULE , it indicates that when the primary key is deleted, rows that imported that key are deleted.

RESTRICT
const long RESTRICT = 1;
Description
a possible value for the column's UPDATE_RULE and DELETE_RULE 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() .

For the column UPDATE_RULE , it indicates that a primary key may not be updated if it has been imported by another table as a foreign key.

For the column DELETE_RULE , it indicates that a primary key may not be deleted if it has been imported by another table as a foreign key.

SET_NULL
const long SET_NULL = 2;
Description
a possible value for the column's UPDATE_RULE and DELETE_RULE 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() .

For the columns UPDATE_RULE and DELETE_RULE , it indicates that when the primary key is updated or deleted, the foreign key (imported key) is changed to NULL .

NO_ACTION
const long NO_ACTION = 3;
Description
a possible value for the column's UPDATE_RULE and DELETE_RULE 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() .

For the columns UPDATE_RULE and DELETE_RULE , it indicates that if the primary key has been imported, it cannot be updated or deleted.

SET_DEFAULT
const long SET_DEFAULT = 4;
Description
a possible value for the column's UPDATE_RULE and DELETE_RULE 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() .

For the columns UPDATE_RULE and DELETE_RULE , it indicates that if the primary key is updated or deleted, the foreign key (imported key) is set to the default value.

Top of Page

Copyright © 2003 Sun Microsystems, Inc.