001/*
002 * HA-JDBC: High-Availability JDBC
003 * Copyright (c) 2004-2007 Paul Ferraro
004 * 
005 * This library is free software; you can redistribute it and/or modify it 
006 * under the terms of the GNU Lesser General Public License as published by the 
007 * Free Software Foundation; either version 2.1 of the License, or (at your 
008 * option) any later version.
009 * 
010 * This library is distributed in the hope that it will be useful, but WITHOUT
011 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 
012 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License 
013 * for more details.
014 * 
015 * You should have received a copy of the GNU Lesser General Public License
016 * along with this library; if not, write to the Free Software Foundation, 
017 * Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
018 * 
019 * Contact: ferraro@users.sourceforge.net
020 */
021package net.sf.hajdbc;
022
023import java.util.List;
024
025
026/**
027 * Represents a foreign key constraint on a table.
028 * 
029 * @author  Paul Ferraro
030 * @since   1.1
031 */
032public interface ForeignKeyConstraint extends UniqueConstraint
033{
034        /**
035         * @return the foreign table of this foreign key
036         */
037        public String getForeignTable();
038        
039        /**
040         * @return the foreign column of this foreign key
041         */
042        public List<String> getForeignColumnList();
043        
044        /**
045         * @return Returns the deleteRule.
046         */
047        public int getDeleteRule();
048
049        /**
050         * @return Returns the updateRule.
051         */
052        public int getUpdateRule();
053
054        /**
055         * @return Returns the deferrability.
056         */
057        public int getDeferrability();
058
059        /**
060         * @param deferrability The deferrability to set.
061         */
062        public void setDeferrability(int deferrability);
063
064        /**
065         * @param deleteRule The deleteRule to set.
066         */
067        public void setDeleteRule(int deleteRule);
068
069        /**
070         * @param foreignTable The foreignTable to set.
071         */
072        public void setForeignTable(String foreignTable);
073
074        /**
075         * @param updateRule The updateRule to set.
076         */
077        public void setUpdateRule(int updateRule);
078}