/* ===================================================================
 * IngredientDao.java
 * 
 * Created Aug 11, 2004 12:08:57 PM
 * 
 * Copyright (c) 2004 Matt Magoffin (spamsqr@msqr.us)
 * 
 * This program is free software; you can redistribute it and/or 
 * modify it under the terms of the GNU General Public License as 
 * published by the Free Software Foundation; either version 2 of 
 * the License, or (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful, 
 * but WITHOUT ANY WARRANTY; without even the implied warranty of 
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 
 * General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License 
 * along with this program; if not, write to the Free Software 
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 
 * 02111-1307 USA
 * ===================================================================
 * $Id: IngredientDao.java 4 2009-05-01 03:27:53Z msqr $
 * ===================================================================
 */

package magoffin.matt.ieat.dao;

import java.util.List;

import magoffin.matt.dao.GenericDao;
import magoffin.matt.ieat.domain.Ingredient;

/**
 * DAO for Ingredient objects.
 * 
 * @author Matt Magoffin (spamsqr@msqr.us)
 * @version $Revision: 4 $ $Date: 2009-05-01 15:27:53 +1200 (Fri, 01 May 2009) $
 */
public interface IngredientDao extends GenericDao<Ingredient,Integer> {
	
	/**
	 * Get a list of Ingredient objects.
	 * @return list of Ingredient objects
	 */
	public List<Ingredient> getIngredients();
	
	/**
	 * Callback for indexing ingredients.
	 */
	public static interface IngredientIndexCallback {
		
		/**
		 * Handle indexing a single Ingredient.
		 * @param data the ingredient data to index
		 */
		public void handle(IngredientIndexCallbackData data);
	}
	
	/**
	 * The API for ingredient data for indexing.
	 */
	public static interface IngredientIndexCallbackData {
		
		/**
		 * Get the ingredient ID.
		 * @return the ID
		 */
		public Integer getIngredientId();
		
		/**
		 * Get the ingredient name.
		 * @return the name
		 */
		public String getName();
	}
	
	/**
	 * Index all ingredients.
	 * @param callback the callback implementation
	 */
	public void index(IngredientIndexCallback callback);

}
