org.marketcetera.strategy.Executor Maven / Gradle / Ivy

Go to download
package org.marketcetera.strategy;

import org.marketcetera.core.ClassVersion;

/* $License$ */

/**
 * Executes a strategy.
 *
 * @author Colin DuPlantis
 * @version $Id: Executor.java 16154 2012-07-14 16:34:05Z colin $
 * @since 1.0.0
 */
@ClassVersion("$Id: Executor.java 16154 2012-07-14 16:34:05Z colin $")
interface Executor
{
    /**
     * Starts execution of the {@link Strategy}.
     *
     * @return a RunningStrategy value
     * @throws Exception if an error occurs
     */
    RunningStrategy start()
        throws Exception;
    /**
     * Stops execution of a {@link Strategy}.
     *
     * @throws Exception if an error occurs
     */
    void stop()
        throws Exception;
    /**
     * Returns an interpretation of the given exception.
     *
     * @param inE an Exception value
     * @return a String value containing a description of the exception
     */
    String interpretRuntimeException(Exception inE);
    /**
     * Returns the name of the method rendered for the appropriate language.
     *
     * @param inMethodName a String value
     * @return a String value
     */
    String translateMethodName(String inMethodName);
}