package org.marketcetera.marketdata.csv;

import org.marketcetera.util.misc.ClassVersion;
import org.marketcetera.module.DisplayName;
import org.marketcetera.marketdata.AbstractMarketDataModuleMXBean;

import javax.management.MXBean;

/**
 * Exposes {@link CSVFeedCredentials} attributes.
 * 
 * @author toli kuznets
 * @author <a href="mailto:colin@marketcetera.com">Colin DuPlantis</a>
 * @since 2.1.0
 * @version $Id: CSVFeedMXBean.java 16154 2012-07-14 16:34:05Z colin $
 */
@MXBean(true)
@DisplayName("Management Interface for CSV Market Data Adapter")
@ClassVersion("$Id: CSVFeedMXBean.java 16154 2012-07-14 16:34:05Z colin $")
public interface CSVFeedMXBean
        extends AbstractMarketDataModuleMXBean
{
    /**
     * Gets the rate at which data is replayed.
     *
     * @return a <code>String</code> value
     */
    @DisplayName("The rate at which data is replayed")
    public String getReplayRate();
    /**
     * Sets the rate at which data is replayed.
     *
     * @param inReplayRate a <code>String</code> value
     */
    @DisplayName("The rate at which data is replayed")
    public void setReplayRate(String inReplayRate);
    /**
     * Gets the name of the directory in which to find market data.
     *
     * @return a <code>String</code> value
     */
    @DisplayName("The absolute path in which to find market data")
    public String getMarketdataDirectory();
    /**
     * Sets the name of the directory in which to find market data. 
     *
     * @param inDirectory a <code>String</code> value
     */
    @DisplayName("The absolute path in which to find market data")
    public void setMarketdataDirectory(@DisplayName("The absolute path in which to find market data")String inDirectory);
    /**
     * Gets the fully-qualified class name of the CSV event translator.
     *
     * @return a <code>String</code> value
     */
    @DisplayName("The fully-qualified class name of the CSV event translator to use")
    public String getEventTranslatorClassName();
    /**
     * Sets the fully-qualified class name of the CSV event translator.
     *
     * @param inEventTranslatorClassname a <code>String</code> value
     */
    @DisplayName("The fully-qualified class name of the CSV event translator to use")
    public void setEventTranslatorClassName(@DisplayName("The fully-qualified class name of the CSV event translator to use")String inEventTranslatorClassname);
    /**
     * Gets the replay events value.
     *
     * @return a <code>String</code> value
     */
    @DisplayName("Indicates if events should be replayed upon completion")
    public String getReplayEvents();
    /**
     * Sets the replay events value.
     *
     * @param inReplayEvents a <code>String</code> value
     */
    @DisplayName("Indicates if events should be replayed upon completion")
    public void setReplayEvents(String inReplayEvents);
}