001    /*
002     * Copyright 2011 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.kfs.module.cab.batch.dataaccess;
017    
018    import java.util.Collection;
019    
020    import org.kuali.kfs.gl.businessobject.Entry;
021    import org.kuali.kfs.module.cab.businessobject.BatchParameters;
022    import org.kuali.kfs.module.purap.businessobject.CreditMemoAccountRevision;
023    import org.kuali.kfs.module.purap.businessobject.PaymentRequestAccountRevision;
024    import org.kuali.kfs.module.purap.businessobject.PurchaseOrderAccount;
025    
026    public interface ExtractDao {
027        /**
028         * This method implementation should find all GL Entries matching the parameters listed in the batch parameters
029         * 
030         * @param batchParameters Batch Parameters
031         * @return GL Entries
032         */
033        Collection<Entry> findMatchingGLEntries(BatchParameters batchParameters);
034    
035    
036        /**
037         * This method implementation should find valid Credit Memo account line changes as per the batch parameters
038         * 
039         * @param batchParameters Batch Parameters
040         * @return List of Credit memo account history records
041         */
042        Collection<CreditMemoAccountRevision> findCreditMemoAccountRevisions(BatchParameters batchParameters);
043    
044        /**
045         * This method implementation should find valid Payment Request account line changes as per the batch parameters
046         * 
047         * @param batchParameters Batch Parameters
048         * @return List of Payment Request account history records
049         */
050        Collection<PaymentRequestAccountRevision> findPaymentRequestAccountRevisions(BatchParameters batchParameters);
051    
052        /**
053         * This method implementation should retrieve all eligible pretaggable PO account lines from Purchasing module
054         * 
055         * @param batchParameters Batch Parameters
056         * @return List of pre-taggable purchase order account lines
057         */
058        Collection<PurchaseOrderAccount> findPreTaggablePOAccounts(BatchParameters batchParameters);
059    
060    }