001    /**
002     * Copyright 2010-2013 The Kuali Foundation
003     *
004     * Licensed under the Educational Community License, Version 2.0 (the "License");
005     * you may not use this file except in compliance with the License.
006     * You may obtain a copy of the License at
007     *
008     * http://www.opensource.org/licenses/ecl2.php
009     *
010     * Unless required by applicable law or agreed to in writing, software
011     * distributed under the License is distributed on an "AS IS" BASIS,
012     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013     * See the License for the specific language governing permissions and
014     * limitations under the License.
015     */
016    package org.kuali.common.jdbc.supplier;
017    
018    import java.io.IOException;
019    import java.util.List;
020    
021    /**
022     * @deprecated
023     */
024    @Deprecated
025    public interface SqlSupplier extends Comparable<SqlSupplier> {
026    
027            /**
028             * Open the supplier so it is ready to provide SQL
029             */
030            void open() throws IOException;
031    
032            /**
033             * Return a list of SQL statements to execute. Returns <code>null</code> when the SQL supply has been exhausted.
034             */
035            List<String> getSql() throws IOException;
036    
037            /**
038             * Close the supplier to free any resources it may have opened
039             */
040            void close();
041    
042            /**
043             * Fill in SQL count + overall size
044             */
045            void fillInMetaData();
046    
047            /**
048             * Return SQL count and overall size
049             */
050            @Deprecated
051            org.kuali.common.jdbc.SqlMetaData getMetaData();
052    
053    }