/*
 * Copyright 2005 the original author or authors.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */ 
package org.wamblee.photos.model.filesystem;

import java.io.File;
import java.io.IOException;
import java.util.List;

import org.wamblee.photos.model.PhotoEntry;

/**
 * Callback for the traverse method call of the filesystem album. 
 */
public interface EntryFoundCallback {
    /**
     * Callback executed when a photo entry has been found.
     * @param aEntries Current list of photo entries.  
     * @param aThumbnail Path of the thumbnail image. 
     * @param aPhoto Path of the full-size image. 
     * @param aPath Path in the photo album. 
     * @return True if the search should continue, false otherwise. 
     */
	boolean photoFound(List<PhotoEntry> aEntries, File aThumbnail, File aPhoto, String aPath);
    
    /**
     * Callback executed when a photo album has been found.
     * @param aEntries Current list of photo entries.  
     * @param aAlbum Path of the photo album directory. 
     * @param aPath Path in the photo album. 
     * @return True if the search should continue, false otherwise. 
     * @throws IOException In case of IO problems. 
     */
	boolean albumFound(List<PhotoEntry> aEntries, File aAlbum, String aPath) throws IOException;
}