RelatedOrder.java

package org.marketcetera.trade;

import org.marketcetera.util.misc.ClassVersion;

/* $License$ */
/**
 * Orders that are related to an existing order. These orders
 * are usually used to cancel or replace an existing order. This type is
 * not meant to be used directly. Use one of its subtypes. 
 *
 * @author anshul@marketcetera.com
 * @version $Id: RelatedOrder.java 16154 2012-07-14 16:34:05Z colin $
 * @since 1.0.0
 */
@ClassVersion("$Id: RelatedOrder.java 16154 2012-07-14 16:34:05Z colin $")
public interface RelatedOrder extends OrderBase {
    /**
     * The original order ID of the order that is being cancelled or replaced.
     *
     * @return the orderID of the order being cancelled or replaced.
     */
    OrderID getOriginalOrderID();

    /**
     * Set the original order ID of the order that is being cancelled.
     *
     * @param inOrderID the orderID of the order being cancelled.
     */
    void setOriginalOrderID(OrderID inOrderID);

    /**
     * The order ID assigned by broker to the original order.
     *
     * @return the broker assigned order ID.
     */
    String getBrokerOrderID();

    /**
     * Set the broker assigned order ID.
     * 
     * @param inBrokerOrderID the broker assigned order ID.
     */
    void setBrokerOrderID(String inBrokerOrderID);
}