package org.marketcetera.marketdata.yahoo;

import javax.management.MXBean;

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

/* $License$ */

/**
 * Provides an MX interface for the Yahoo market data feed.
 *
 * @author <a href="mailto:colin@marketcetera.com">Colin DuPlantis</a>
 * @version $Id: YahooFeedMXBean.java 16154 2012-07-14 16:34:05Z colin $
 * @since 2.1.4
 */
@MXBean(true)
@DisplayName("Management Interface for the Yahoo Marketdata Feed")
@ClassVersion("$Id: YahooFeedMXBean.java 16154 2012-07-14 16:34:05Z colin $")
public interface YahooFeedMXBean
        extends AbstractMarketDataModuleMXBean
{
    /**
     * Returns the URL that describes the location of the Yahoo server.
     *
     * @return a <code>String</code> value
     */
    @DisplayName("The URL for the Yahoo server")
    public String getURL();
    /**
     * Sets the URL that describes the location of the Marketcetera Exchange server.
     *
     * @param inURL a <code>String</code> value
     */
    @DisplayName("The URL for the Yahoo server")
    public void setURL(@DisplayName("The URL for the Yahoo server")
                       String inURL);
    /**
     * Gets the interval at which to refresh market data in ms.
     *
     * @return a <code>String</code> value
     */
    @DisplayName("The rate at which to refresh market data")
    public String getRefreshInterval();
    /**
     * Sets the interval at which to refresh market data in ms.
     *
     * @param inRefreshInterval a <code>String</code> value
     */
    @DisplayName("The rate at which to refresh market data")
    public void setRefreshInterval(@DisplayName("The rate at which to refresh market data")
                                   String inRefreshInterval);
    /**
     * Gets the number of requests that have been made.
     *
     * @return a <code>long</code> value
     */
    @DisplayName("The number of requests made since start or reset")
    public long getRequestCounter();
    /**
     * Resets the request counter.
     */
    @DisplayName("Resets the request counter")
    public void resetRequestCounter();
}