Application: gvSIG desktop » gvSIG scripting

package org.gvsig.scripting;

import java.io.File;

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{

        /**

         * Gets a String with the ScriptBaseScript's file path.

         *

         * @return a string with the path of the ScriptBaseScript main file path.

         */

        public String getPath();

        /**

         * Executes the code of a ScriptBaseScript.

         * 

         */

        public Object run();

        /**

         * Executes the code of a ScriptBaseScript.

         * 

         * @param args

         *                         Contains the input parameters to run the ScriptBaseScript.   

         */

        public Object run(Object args[]);

        /**

         * Sets the ScriptBaseScript's current status with the saved version.

         *

         * @param saved 

         *                         Indicate if the ScriptBaseScript is up-to-date or not.

         */

        public void setSaved(boolean saved);

        /**

         * Indicates if the ScriptBaseScript is modified from last saved version.

         * 

         * @return true if current version is up-to-date, false if not.

         */

        public boolean isSaved();

        public void compile() throws ScriptingRunningException;

        public void put(String name, Object value);

        /**

         * Return a resource File that is beside this script.

         * 

         * @return the file which is beside this script

         */

        public File getResource(String filename);

}