package org.marketcetera.event;

import java.math.BigDecimal;

import org.marketcetera.util.misc.ClassVersion;

/* $License$ */

/**
 * Represents a single market data message from a market data provider.
 *
 * @author <a href="mailto:colin@marketcetera.com">Colin DuPlantis</a>
 * @version $Id: MarketDataEvent.java 16867 2014-03-23 23:06:05Z colin $
 * @since 2.0.0
 */
@ClassVersion("$Id: MarketDataEvent.java 16867 2014-03-23 23:06:05Z colin $")
public interface MarketDataEvent
        extends Event, HasInstrument, HasEventType
{
    /**
     * Gets the exchange on which the market data event occurred.
     *
     * @return a <code>String</code> value
     */
    public String getExchange();
    /**
     * Gets the price of the market data event. 
     *
     * @return a <code>BigDecimal</code> value
     */
    public BigDecimal getPrice();
    /**
     * Gets the size of the market data event.
     *
     * @return a <code>BigDecimal</code> value
     */
    public BigDecimal getSize();
    /**
     * Gets the time the event occurred. 
     *
     * <p>The format of the returned value is dependent on the
     * originating market data provider.
     *
     * @return a <code>String</code> value
     */
    public String getExchangeTimestamp();
    /**
     * Gets the type of the event.
     *
     * @return an <code>EventMetaType</code> value
     */
    public EventType getEventType();
    /**
     * Sets the type of the event.
     *
     * @param inEventType an <code>EventMetaType</code> value
     */
    public void setEventType(EventType inEventType);
}