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    /**
027     * Provides all database table REF column specific metadata.
028     * 
029     * @author <a href="mailto:litsenko_sergey@yahoo.com">Sergiy Litsenko</a>
030     */
031    public interface Reference extends CoreMetaData {
032        /**
033         * Returns table name that this the scope of a reference attribure
034         * 
035         * @return table name that this the scope of a reference attribure
036         */
037        Table getSourceTable();
038    
039        /**
040         * Sets table name that this the scope of a reference attribure
041         * 
042         * @param sourceTable table name that this the scope of a reference attribure
043         */
044        void setSourceTable( Table sourceTable );
045    
046        /**
047         * Returns source type of a distinct type or user-generated Ref type.
048         * 
049         * @return source type of a distinct type or user-generated Ref type,
050         */
051        SqlType getSourceDataType();
052    
053        /**
054         * Sets source type of a distinct type or user-generated Ref type.
055         * 
056         * @param sourceDataType source type of a distinct type or user-generated Ref type,
057         */
058        void setSourceDataType( SqlType sourceDataType );
059    }