Application: gvSIG desktop » gvSIG scripting

package org.gvsig.scripting;

import java.io.File;

/**

 * <p> Interface that represents the elements used in the ScriptingFramework.</p>

 * 

 * @see ScriptingBaseScript

 * @see ScriptingFolder

 */

public interface ScriptingUnit {

        /**

         * Returns the ScriptingUnit's ID

         * 

         * @return a String containing the ScriptingUnit's ID

         */

        public String getId();

        /**

         * Returns the ScriptingUnit's name

         * 

         * @return a String containing the ScriptingUnit's name

         */

        public String getName();

        /**

         * Returns the ScriptingUnit's description

         * 

         * @return a String containing the ScriptingUnit's description

         */

        public String getDescription();

        /**

         * Returns information about the ScriptingUnit's creator

         * 

         * @return a String containing the ScriptingUnit's creator

         */

        public String getCreatedBy();

        /**

         * Returns the ScriptingUnit's version

         * 

         * @return a String containing the ScriptingUnit's version

         */

        public String getVersion();

        /**

         * Returns the ScriptingUnit's parent

         * 

         * @return a {@link ScriptingFolder} where is contained the ScriptingUnit

         */

        public ScriptingFolder getParent();

        /**

         * Sets a new name to the ScriptingUnit.

         *

         * @param name

         *            String that contains the new name.

         */

        public void setName(String name);

        /**

         * Sets a new description to the ScriptingUnit.

         *

         * @param description

         *            String that contains the new description.

         */

        public void setDescription(String description);

        /**

         * Sets a new information about the ScriptingUnit's creator.

         *

         * @param createdBy

         *            String that contains the new creator's information.

         */

        public void setCreatedBy(String createdBy);

        /**

         * Sets a new version value to the ScriptingUnit.

         *

         * @param version

         *            String that contains the new version.

         */

        public void setVersion(String version);

        /**

         * Changes the ID of a ScriptingUnit and the name of the files and/or directories associated

         *

         * @param newId

         *            String that contains the new Id.

         *            

         * @return true if it's succesful, false if not.

         */

        public boolean rename(String newId);

        public boolean remove();

        /**

         * Moves a ScriptingUnitfrom the current directory to the new location.

         *

         * @param target

         *            {@link ScriptingFolder} that represents the destination..

         *            

         * @return true if it's succesful, false if not.

         */

        public boolean move(ScriptingFolder target);

        /**

         * Gets the name of the icons associated to the ScriptingUnit type.

         *            

         * @return a String array with the identificators of the icons associated.

         */

        public String[] getIconNames();

        public String getTypeName();

        /**

         * Gets a File with the ScriptUnit path name.

         *

         * @return a string with the path name of the ScriptUnit (inf/folder).

         */

        public File getFile();

}