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.dataaccess;
017    
018    import org.kuali.kfs.module.ar.businessobject.CashControlDetail;
019    
020    public interface CashControlDetailDao {
021    
022        /**
023         * 
024         * Retrieves the CashControlDetail object associated with a given reference Document 
025         * Number.
026         * 
027         * This will typically be the PaymentApplication Document Number that is generated by 
028         * the CashControl document.
029         * 
030         * @param referenceDocumentNumber The PayApp document number you want to find the associated 
031         *                                CashControlDetail record for.
032         * @return The associated CashControlDetail record if it exists, null if it doesnt.
033         */
034        public CashControlDetail getCashControlDetailByRefDocNumber(String referenceDocumentNumber);
035        
036    }