/* ===========================================================
 * TradeManager : An application to trade strategies for the Java(tm) platform
 * ===========================================================
 *
 * (C) Copyright 2011-2011, by Simon Allen and Contributors.
 *
 * Project Info:  org.trade
 *
 * This library is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; either version 2.1 of the License, or
 * (at your option) any later version.
 *
 * This library 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 Lesser General Public
 * License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301,
 * USA.
 *
 * [Java is a trademark or registered trademark of Oracle, Inc.
 * in the United States and other countries.]
 *
 * (C) Copyright 2011-2011, by Simon Allen and Contributors.
 *
 * Original Author:  Simon Allen;
 * Contributor(s):   -;
 *
 * Changes
 * -------
 *
 */
package org.trade.core.message;

import org.trade.core.exception.ExceptionContext;
import org.trade.core.exception.ExceptionMessage;

/**
 * A class that implements this interface is capable of creating
 * <code>ExceptionMessage</code> objects based on a variety of contextual
 * elements.
 * 
 * @author Simon Allen
 */
public interface IMessageFactory {
	/**
	 * Method create.
	 * 
	 * @return ExceptionMessage
	 */
	ExceptionMessage create();

	/**
	 * @param fieldSequence
	 *            This should be used when checking repeating groups because it
	 *            will cause a group number to be appended to each field
	 *            reference.
	 * @return ExceptionMessage
	 */
	ExceptionMessage create(int fieldSequence);

	/**
	 * Convenience method to add context to the exception message.
	 * 
	 * @param exceptionContext
	 *            ExceptionContext
	 * @return ExceptionMessage
	 */
	ExceptionMessage create(ExceptionContext exceptionContext);

	/**
	 * Convenience method to add context to the exception message.
	 * 
	 * @param exceptionContext1
	 *            ExceptionContext
	 * @param exceptionContext2
	 *            ExceptionContext
	 * @return ExceptionMessage
	 */
	ExceptionMessage create(ExceptionContext exceptionContext1, ExceptionContext exceptionContext2);
}