001    /*
002     * JBoss DNA (http://www.jboss.org/dna)
003     * See the COPYRIGHT.txt file distributed with this work for information
004     * regarding copyright ownership.  Some portions may be licensed
005     * to Red Hat, Inc. under one or more contributor license agreements.
006     * See the AUTHORS.txt file in the distribution for a full listing of 
007     * individual contributors. 
008     *
009     * JBoss DNA is free software. Unless otherwise indicated, all code in JBoss DNA
010     * is licensed to you under the terms of the GNU Lesser General Public License as
011     * published by the Free Software Foundation; either version 2.1 of
012     * the License, or (at your option) any later version.
013     *
014     * JBoss DNA is distributed in the hope that it will be useful,
015     * but WITHOUT ANY WARRANTY; without even the implied warranty of
016     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
017     * Lesser General Public License for more details.
018     *
019     * You should have received a copy of the GNU Lesser General Public
020     * License along with this software; if not, write to the Free
021     * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
022     * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
023     */
024    package org.jboss.dna.common.jdbc.model.api;
025    
026    import java.util.Set;
027    
028    /**
029     * Provides database table's foreing key specific metadata.
030     * 
031     * @author <a href="mailto:litsenko_sergey@yahoo.com">Sergiy Litsenko</a>
032     */
033    public interface ForeignKey extends SchemaObject {
034    
035        /**
036         * Retrieves foreign key columns
037         * 
038         * @return foreign key columns
039         */
040        Set<ForeignKeyColumn> getColumns();
041    
042        /**
043         * Adds ForeignKeyColumn
044         * 
045         * @param column the ForeignKeyColumn
046         */
047        void addColumn( ForeignKeyColumn column );
048    
049        /**
050         * deletes ForeignKeyColumn
051         * 
052         * @param column the ForeignKeyColumn
053         */
054        void deleteColumn( ForeignKeyColumn column );
055    
056        /**
057         * Returns table column for specified column name or null
058         * 
059         * @param columnName the name of column
060         * @return table column for specified column name or null.
061         */
062        ForeignKeyColumn findColumnByName( String columnName );
063    
064        /**
065         * Returns the scope table of a foreign key.
066         * 
067         * @return the scope table of a foreign key.
068         */
069        Table getSourceTable();
070    
071        /**
072         * Sets the scope table of a foreign key.
073         * 
074         * @param sourceTable the scope table of a foreign key.
075         */
076        void setSourceTable( Table sourceTable );
077    
078        /**
079         * Returns the PK of scope table.
080         * 
081         * @return the PK of scope table.
082         */
083        PrimaryKey getSourcePrimaryKey();
084    
085        /**
086         * Sets the PK of scope table.
087         * 
088         * @param primaryKey the PK of scope table.
089         */
090        void setSourcePrimaryKey( PrimaryKey primaryKey );
091    
092        /**
093         * What happens to a foreign key when the primary key is updated
094         * 
095         * @return what happens to a foreign key when the primary key is updated
096         */
097        KeyModifyRuleType getUpdateRule();
098    
099        /**
100         * What happens to a foreign key when the primary key is updated
101         * 
102         * @param updateRule what happens to a foreign key when the primary key is updated
103         */
104        void setUpdateRule( KeyModifyRuleType updateRule );
105    
106        /**
107         * What happens to a foreign key when the primary key is deleted
108         * 
109         * @return what happens to a foreign key when the primary key is deleted
110         */
111        KeyModifyRuleType getDeleteRule();
112    
113        /**
114         * What happens to a foreign key when the primary key is deleted
115         * 
116         * @param deleteRule what happens to a foreign key when the primary key is deleted
117         */
118        void setDeleteRule( KeyModifyRuleType deleteRule );
119    
120        /**
121         * Can the evaluation of foreign key constraints be deferred until commit
122         * 
123         * @return the evaluation of foreign key constraints be deferred until commit
124         */
125        KeyDeferrabilityType getDeferrability();
126    
127        /**
128         * Can the evaluation of foreign key constraints be deferred until commit
129         * 
130         * @param deferrability the evaluation of foreign key constraints be deferred until commit
131         */
132        void setDeferrability( KeyDeferrabilityType deferrability );
133    }