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.ar.document.service;
017    
018    import java.util.Collection;
019    
020    import org.kuali.kfs.module.ar.businessobject.AppliedPayment;
021    import org.kuali.kfs.module.ar.businessobject.InvoicePaidApplied;
022    import org.kuali.kfs.module.ar.document.CustomerInvoiceDocument;
023    
024    public interface InvoicePaidAppliedService<T extends AppliedPayment> {
025        
026        public Integer getNumberOfInvoicePaidAppliedsForInvoiceDetail(String financialDocumentReferenceInvoiceNumber, Integer invoiceItemNumber);
027        
028        /**
029         * 
030         * Clears all the PaidApplieds for the given document number from the database.
031         * This is typically done prior to loading a new set of lines in.
032         * 
033         * NOTE that this will delete the Paid Applieds that were generated BY the 
034         * documentNumber passed in, not that apply TO the documentNumber passed in.
035         * 
036         * @param documentNumber
037         */
038        public void clearDocumentPaidAppliedsFromDatabase(String documentNumber);
039        
040        /**
041         * This method doesn't go to the database to get related invoice paid applieds.
042         * It looks at a specific document to get the relations worked out.
043         * 
044         * @param customerInvoiceDetail
045         * @param paymentApplicationDocument
046         * @return
047         */
048    //    public Collection<InvoicePaidApplied> getInvoicePaidAppliedsForCustomerInvoiceDetail(CustomerInvoiceDetail customerInvoiceDetail, PaymentApplicationDocument paymentApplicationDocument);
049        
050        /**
051         * This method returns true if invoice has applied amounts (i.e. from application, credit memo, etc), not including
052         * discounts
053         * 
054         * @param document
055         * @return
056         */
057        public boolean doesInvoiceHaveAppliedAmounts(CustomerInvoiceDocument document);
058    
059        /**
060         * @param documentNumber
061         * @return
062         */
063        public Collection<InvoicePaidApplied> getInvoicePaidAppliedsForInvoice(String documentNumber);
064    
065        /**
066         * @param documentNumber
067         * @return
068         */
069        public Collection<InvoicePaidApplied> getInvoicePaidAppliedsForInvoice(CustomerInvoiceDocument invoice);
070        
071        /**
072         * @param customerInvoiceDetail
073         * @return
074         */
075    //    public Collection<InvoicePaidApplied> getInvoicePaidAppliedsForCustomerInvoiceDetail(CustomerInvoiceDetail customerInvoiceDetail);
076    //    public Collection<InvoicePaidApplied> getApprovedInvoicePaidAppliedsForCustomerInvoiceDetail(CustomerInvoiceDetail customerInvoiceDetail);
077    //    public Collection<InvoicePaidApplied> getInvoicePaidAppliedsForCustomerInvoiceDetail(CustomerInvoiceDetail customerInvoiceDetail, String applicationDocNumber);
078    //    public Collection<InvoicePaidApplied> getInvoicePaidAppliedsFromSpecificDocument(String documentNumber, String referenceCustomerInvoiceDocumentNumber);
079        
080    }