Application: gvSIG desktop » gvSIG scripting

package org.gvsig.scripting;

import org.gvsig.tools.script.Script;

/**

 * <p> Interface that represents a single script without window dialog.</p>

 * 

 * @see ScriptingUnit

 * @see ScriptingBaseScript

 */

public interface ScriptingScript extends ScriptingBaseScript, Script {

        /**

         * Returns the languange in which the ScriptingScript is written.

         * 

         * @return a String containing the name of the language

         */

        public String getLangName();

        /**

         * Returns the ScriptingScript's code.

         * 

         * @return a String with the code of the script.

         */

        @Override

        public String getCode();

        /**

         * Sets a the code associated with a ScriptingScript.

         *

         * @param code

         *            String that contains the new code.

         */

        public void setCode(String code);

        /**

         * Returns the name of the main function in the ScriptingScript's code

         * 

         * @return a String with main function (default main name is 'main').

         */

        public String getMainName();

        /**

         * Stablishes a new main main function in the ScriptingScript's code.

         *

         * @param mainName

         *            String that contains the new main function name.

         */

        public void setMainName(String mainName);

        /**

         * Persists the current status of a ScriptingScript with the content associated.

         */

        public void save();

        /**

         * Executes a method from the Script's code

         * 

         * @param obj this Object represents the script's code

         * @param name method's name to execute

         * @param args input parameters of the method 

         * 

         * @return An Object that represents the execution

         * 

         * @throws NoSuchMethodException If there isn't a main function to begin the execution

         */

        public Object invokeMethod(Object obj, String name, Object[] args) throws NoSuchMethodException;

        /**

         * Executes a function from the Script's code

         * 

         * @param name method's name to execute

         * @param args input parameters of the method 

         * 

         * @return An Object that represents the execution

         * 

         * @throws NoSuchMethodException If there isn't a main function to begin the execution

         */

        @Override

        public Object invokeFunction(String name, Object[] args) throws NoSuchMethodException;

        public String getMimeType();

        public void registerDataFolder(String id);

}