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.gl.batch.service;
017    
018    import java.util.Iterator;
019    import java.util.List;
020    
021    import org.kuali.kfs.gl.batch.service.impl.ReconciliationBlock;
022    import org.kuali.kfs.gl.businessobject.OriginEntryFull;
023    import org.kuali.kfs.sys.Message;
024    
025    /**
026     * An object to reconcile origin entries. Since the {@link #reconcile(Iterator, ReconciliationBlock, List)} method below takes in an
027     * iterator (which may load entries from the DB as the {@link Iterator#next()} method is called), it is probably desirable for
028     * implementations to annotate the class as Transactional.
029     */
030    public interface ReconciliationService {
031    
032        /**
033         * Performs the reconciliation on origin entries using the data from the {@link ReconciliationBlock} parameter
034         * 
035         * @param entries origin entries
036         * @param reconBlock reconciliation data
037         * @param errorMessages a non-null list onto which error messages will be appended. This list will be modified by reference.
038         */
039        public void reconcile(Iterator<OriginEntryFull> entries, ReconciliationBlock reconBlock, List<Message> errorMessages);
040    }