package org.marketcetera.marketdata;

import static org.marketcetera.marketdata.Messages.INSTRUMENT_OR_UNDERLYING_INSTRUMENT_REQUIRED;
import static org.marketcetera.marketdata.Messages.OPTION_REQUIRES_UNDERLYING_INSTRUMENT;

import java.io.Serializable;

import javax.annotation.concurrent.Immutable;

import org.marketcetera.event.HasInstrument;
import org.marketcetera.event.HasUnderlyingInstrument;
import org.marketcetera.trade.Instrument;
import org.marketcetera.trade.Option;
import org.marketcetera.util.misc.ClassVersion;

/**
 * Encapsulates elements of a marker data request to an {@link Exchange}.
 * 
 * <p>To create an <code>ExchangeRequest</code>, use an {@link ExchangeRequestBuilder}.
 *
 * @author <a href="mailto:colin@marketcetera.com">Colin DuPlantis</a>
 * @version $Id: ExchangeRequest.java 16154 2012-07-14 16:34:05Z colin $
 * @since 2.0.0
 */
@Immutable
@ClassVersion("$Id: ExchangeRequest.java 16154 2012-07-14 16:34:05Z colin $")
public final class ExchangeRequest
        implements Serializable, HasInstrument, HasUnderlyingInstrument
{
    /**
     * Get the instrument value.
     *
     * @return an <code>Instrument</code> value
     */
    public Instrument getInstrument()
    {
        return instrument;
    }
    /**
     * Get the underlying instrument value.
     *
     * @return an <code>Instrument</code> value
     */
    public Instrument getUnderlyingInstrument()
    {
        return underlyingInstrument;
    }
    /* (non-Javadoc)
     * @see org.marketcetera.event.HasInstrument#getInstrumentAsString()
     */
    @Override
    public String getInstrumentAsString()
    {
        if(instrument == null) {
            return null;
        }
        return getInstrument().getSymbol();
    }
    /**
     * Indicates if this request specifies only an
     * underlying <code>Instrument</code>.
     *
     * @return a <code>boolean</code> value
     */
    public boolean isForUnderlyingOnly()
    {
        return instrument == null &&
               underlyingInstrument != null;
    }
    /* (non-Javadoc)
     * @see java.lang.Object#toString()
     */
    @Override
    public String toString()
    {
        return String.format("ExchangeRequest [instrument=%s, underlyingInstrument=%s]", //$NON-NLS-1$
                             instrument,
                             underlyingInstrument);
    }
    /**
     * Create a new ExchangeRequest instance.
     *
     * @param inInstrument an <code>Instrument</code> value or <code>null</code>
     * @param inUnderlyingInstrument an <code>Instrument</code> value or <code>null</code>
     * @throws IllegalArgumentException if the request is not valid
     */
    ExchangeRequest(Instrument inInstrument,
                    Instrument inUnderlyingInstrument)
    {
        instrument = inInstrument;
        underlyingInstrument = inUnderlyingInstrument;
        validate();
    }
    /**
     * Validates the <code>ExchangeRequest</code>.
     *
     * @throws IllegalArgumentException if the request is not valid
     */
    private void validate()
    {
        // if instrument is null, underlying must be specified
        if(instrument == null &&
           underlyingInstrument == null) {
            throw new IllegalArgumentException(INSTRUMENT_OR_UNDERLYING_INSTRUMENT_REQUIRED.getText());
        }
        // if instrument is specified and its an option, underlying must be specified
        if(instrument != null &&
           instrument instanceof Option &&
           underlyingInstrument == null) {
            throw new IllegalArgumentException(OPTION_REQUIRES_UNDERLYING_INSTRUMENT.getText(instrument));
        }
    }
    /**
     * the instrument of the exchange request, may be <code>null</code>
     */
    private final Instrument instrument;
    /**
     * the underlying instrument of the exchange request, may be <code>null</code>
     */
    private final Instrument underlyingInstrument;
    private static final long serialVersionUID = 1L;
}