/* ===================================================================
 * UnitDao.java
 * 
 * Copyright (c) 2004 Matt Magoffin. Created Aug 8, 2004 7:19:00 PM.
 * 
 * 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: UnitDao.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.System;
import magoffin.matt.ieat.domain.Unit;

/**
 * DAO for Unit objects.
 * 
 * @author Matt Magoffin (spamsqr@msqr.us)
 * @version $Revision: 4 $ $Date: 2009-05-01 15:27:53 +1200 (Fri, 01 May 2009) $
 */
public interface UnitDao extends GenericDao<Unit,Integer> {

	/**
	 * Get a list of Unit objects relevant to a given system.
	 * @param sys the System
	 * @return list of Unit objects
	 */
	public List<Unit> getUnitsForSystem(System sys);
	
	/**
	 * Get a list of Unit objects.
	 * @return list of Unit objects
	 */
	public List<Unit> getUnits();
	
	/**
	 * Index using a callback.
	 * @param callback the callback
	 */
	public void index(UnitIndexCallback callback);
	
	/**
	 * Callback for indexing units.
	 */
	public static interface UnitIndexCallback {
		
		/**
		 * Handle indexing a single Unit.
		 * @param data the unit data to index
		 */
		public void handle(UnitIndexCallbackData data);
	}
	
	/**
	 * The API for unit data for indexing.
	 */
	public static interface UnitIndexCallbackData {
		
		/**
		 * Get the unit ID.
		 * @return the ID
		 */
		public Integer getUnitId();
		
		/**
		 * Get the unit name.
		 * @return the name
		 */
		public String getName();
		
		/**
		 * Get the unit abbreviation.
		 * @return the abbreviation
		 */
		public String getAbbreviation();
	}
	
}
