001    /**
002     * Copyright 2004-2012 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.threads.listener;
017    
018    /**
019     * Listen for events related to making progress towards an overall total.
020     *
021     * @param <T>
022     */
023    public interface ProgressListener<T> {
024    
025        /**
026         * Progress has begun
027         */
028        void progressStarted();
029    
030        /**
031         * Progress towards the total has occurred
032         *
033         * @param count
034         * @param total
035         * @param event
036         */
037        void progressOccurred(int count, int total, ProgressEvent<T> event);
038    
039        /**
040         * Progress is now complete
041         */
042        void progressCompleted();
043    }