Application: gvSIG desktop » gvSIG scripting

package org.gvsig.scripting;

import java.io.File;

import java.io.Writer;

import org.gvsig.tools.observer.WeakReferencingObservable;

/**

 * <p>

 * Interface that represents Scripting elements.</p>

 *

 * @see ScriptingUnit

 *

 * @see ScriptingScript

 * @see ScriptingDialog

 * @see ScriptingProject

 */

public interface ScriptingBaseScript extends ScriptingUnit, WeakReferencingObservable {

    public static final int ISOLATION_LOW = 0;

    public static final int ISOLATION_HIGH = 10;

    /**

     * Check if the script execution is enabled.

     *

     * @return if the script is enabled.

     */

    public boolean isEnabled();

    /**

     * Enable or disable the sript execution.

     *

     * @param enabled

     */

    public void setEnabled(boolean enabled);

    /**

     * Executes the code of a ScriptBaseScript.

     *

     * @return

     */

    public Object run();

    /**

     * Executes the code of a ScriptBaseScript.

     *

     * @param args Contains the input parameters to run the ScriptBaseScript.

     * @return

     */

    public Object run(Object args[]);

    /**

     * Executes the code of a ScriptBaseScript in a separated thread

     *

     * @param args Contains the input parameters to run the ScriptBaseScript.

     */

    public void runAsTask(Object args[]);

    public void compile() throws ScriptingRunningException;

    public void put(String name, Object value);

    /**

     * Return a resource File that is beside this script.

     *

     * @param filename

     * @return the file which is beside this script

     */

    public File getResource(String filename);

    public File getScriptFile();

    public String getLibrarySuffix();

    public void setLibrarySuffix(String librarySuffix);    

    public void addStdoutWriter(Writer out);

    public void addStderrWriter(Writer err);

    public void removeStdoutWriter(Writer out);

    public void removeStderrWriter(Writer err);

    public void setIsolation(int isolation);

    public int getIsolation();

}