/**
 * <p>
 * Copyright © 2009-2010, Bruce-Robert Pocock
 * </p>
 * <p>
 * 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 3 of the License, or (at
 * your option) any later version.
 * </p>
 * <p>
 * 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.
 * </p>
 * <p>
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 * </p>
 * 
 * @author brpocock
 */
package org.starhope.appius.game;

import org.starhope.appius.user.AbstractUser;

/**
 *
 * WRITEME: The documentation for this type (TrainCar) is incomplete. (brpocock, Dec 14, 2009)
 *
 * @author brpocock
 *
 */
public interface TrainCar extends AbstractUser {

	/**
	 * TODO: document this method (brpocock, Dec 14, 2009)
	 * 
	 * @return WRITEME
	 */
	TrainCar getCaboose ();

	/**
	 * TODO: document this method (brpocock, Dec 14, 2009)
	 * 
	 * @return WRITEME
	 */
	TrainCar getNextInTrain ();

	/**
	 * TODO: document this method (brpocock, Dec 14, 2009)
	 * 
	 * @return WRITEME
	 */
	TrainCar getPriorInTrain ();

	/**
	 * TODO: document this method (brpocock, Dec 14, 2009)
	 * 
	 * @return WRITEME
	 */
	TrainCar getTrainLeader ();

	/**
	 * TODO: document this method (brpocock, Dec 14, 2009)
	 * 
	 * @return WRITEME
	 */
	boolean isInTrain ();
	/**
	 * TODO: document this method (brpocock, Dec 14, 2009)
	 * 
	 * @param trainLeader WRITEME
	 * @return WRITEME
	 */
	boolean isInTrain (TrainCar trainLeader);

	/**
	 * TODO: document this method (brpocock, Dec 14, 2009)
	 * 
	 * @param car WRITEME
	 */
	void setNextInTrain (final TrainCar car);

	/**
	 * TODO: document this method (brpocock, Dec 14, 2009)
	 * 
	 * @param car WRITEME
	 */
	void setPriorInTrain (final TrainCar car);

	/**
	 * TODO: document this method (brpocock, Dec 14, 2009)
	 * 
	 * @param leader WRITEME
	 */
	void setTrainLeader (TrainCar leader);

}