package org.marketcetera.trade;

import java.util.EnumSet;
import java.util.Set;

import org.marketcetera.util.misc.ClassVersion;

/* $License$ */
/**
 * Identifies the type of entity that originated the report.
 *
 * @author anshul@marketcetera.com
 * @version $Id: Originator.java 16888 2014-04-22 18:32:36Z colin $
 * @since 1.0.0
 */
@ClassVersion("$Id: Originator.java 16888 2014-04-22 18:32:36Z colin $")
public enum Originator
{
    /**
     * Indicates that the report was originated by the system's server.
     */
    Server,
    /**
     * Indicates that the report was originated by the FIX broker. 
     */
    Broker;
    /**
     * Indicates that this originator is to be used for position calculations.
     *
     * @return a <code>boolean</code> value
     */
    public boolean forPositions()
    {
        return POSITIONS.contains(this);
    }
    /**
     * Indicates that this originator is to be used for orders.
     *
     * @return a <code>boolean</code> value
     */
    public boolean forOrders()
    {
        return FIX_MESSAGE_VIEWS.contains(this);
    }
    /**
     * originators for positions
     */
    private static final Set<Originator> POSITIONS = EnumSet.of(Broker);
    /**
     * originators for FIX Message Views
     */
    private static final Set<Originator> FIX_MESSAGE_VIEWS = EnumSet.of(Broker);
}