/**
 * Copyright (c) 2015-2018, CJ Hare All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification, are permitted
 * provided that the following conditions are met:
 *
 * * Redistributions of source code must retain the above copyright notice, this list of conditions
 * and the following disclaimer.
 *
 * * Redistributions in binary form must reproduce the above copyright notice, this list of
 * conditions and the following disclaimer in the documentation and/or other materials provided with
 * the distribution.
 *
 * * Neither the name of [project] nor the names of its contributors may be used to endorse or
 * promote products derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY
 * WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package com.systematic.trading.simulation.order;

import com.systematic.trading.model.price.TradingDayPrices;
import com.systematic.trading.simulation.brokerage.BrokerageTransaction;
import com.systematic.trading.simulation.brokerage.BrokerageTransactionFee;
import com.systematic.trading.simulation.brokerage.exception.InsufficientEquitiesException;
import com.systematic.trading.simulation.cash.CashAccount;
import com.systematic.trading.simulation.cash.exception.InsufficientFundsException;
import com.systematic.trading.simulation.order.event.OrderEvent;

/**
 * The trading order that can be executed by a specific brokerage.
 * 
 * @author CJ Hare
 */
public interface EquityOrder {

	/**
	 * Whether the order has yet to expire.
	 * 
	 * @param todaysTrading
	 *            the price action for today.
	 * @return <code>true</code> has expire and should not be executed, <code>false</code>
	 *         otherwise.
	 */
	boolean isValid( TradingDayPrices todaysTrading );

	/**
	 * Whether the day's trading movement satisfied the execution criteria for the order.
	 * 
	 * @param todaysTrading
	 *            the price action for today.
	 * @return <code>true</code> the conditions are met, <code>false</code> otherwise.
	 */
	boolean areExecutionConditionsMet( TradingDayPrices todaysTrading );

	/**
	 * Executes the trade, side affecting the broker and cash account.
	 * 
	 * @param fees
	 *            costs associated with performing transactions.
	 * @param broker
	 *            performs the execution of the order.
	 * @param cashAccount
	 *            where the money for the transaction is withdrawn.
	 * @param todaysTrading
	 *            the price action for today.
	 * @throws OrderException
	 *             when the order fails.
	 */
	void execute(
	        BrokerageTransactionFee fees,
	        BrokerageTransaction broker,
	        CashAccount cashAccount,
	        TradingDayPrices todaysTrading ) throws InsufficientEquitiesException, InsufficientFundsException;

	/**
	 * The type, or details of event that the equity order should be recorded as.
	 * 
	 * @return details of the order for statistical and recording purposes.
	 */
	OrderEvent orderEvent();
}
