Application: gvSIG desktop

/* gvSIG. Geographic Information System of the Valencian Government

 *

 * Copyright (C) 2007-2008 Infrastructures and Transports Department

 * of the Valencian Government (CIT)

 * 

 * This program is free software; you can redistribute it and/or

 * modify it under the terms of the GNU General Public License

 * as published by the Free Software Foundation; either version 2

 * of the License, or (at your option) any later version.

 * 

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 * 

 * You should have received a copy of the GNU General Public License

 * along with this program; if not, write to the Free Software

 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, 

 * MA  02110-1301, USA.

 * 

 */

/*

 * AUTHORS (In addition to CIT):

 * 2010 {Prodevelop}   {Task}

 */

package org.gvsig.installer.lib.api;

import java.io.File;

import org.gvsig.installer.lib.api.InstallerManager.ARCH;

import org.gvsig.installer.lib.api.InstallerManager.JVM;

import org.gvsig.installer.lib.api.InstallerManager.OS;

import org.gvsig.installer.lib.api.InstallerManager.STATE;

/**

 * Information of a package that is used on the installation process.

 * This information is composed by next fields:

 * </br> <li>

 * <lu><b>Code</b>: unique identifier for the package.</lu> <lu><b>Name</b>:

 * name of the package.</lu> <lu><b>Description</b>: brief description of the

 * package functionality</lu> * <lu><b>Version</b>: number of version.</lu>

 * <lu><b>Build</b>: build number.</lu> <lu><b>State</b>: the state of the

 * package (testing, RC1...).</lu> <lu><b>Operating system</b>: the operating

 * system supported (lin, win, mac_10_6, ...).</lu> <lu><b>Architecture</b>: the

 * state of the package (testing, RC1, ...).</lu> <lu><b>JavaVM</b>: the minimum

 * java version supported (1.5, 1.6, ...).</lu> <lu><b>Is Official</b>: if the

 * package is official or if is a not official package.</lu> <lu><b>Type</b>:

 * package type (plugin, theme, translation...). Depending of this value a

 * different installation provider is selected to control the installation

 * process.</lu> <li>

 * 

 * @author <a href="mailto:jpiera@gvsig.org">Jorge Piera Llodr&aacute;</a>

 */

public interface PackageInfo {

    /**

     * @return

     *         Gets the code of the package.

     */

    public String getCode();

    public void setCode(String code);

    /**

     * @return

     *         Gets the name of the package.

     */

    public String getName();

    public void setName(String name);

    /**

     * @return

     *         Gets the description of the package.

     */

    public String getDescription();

    public void setDescription(String description);

    /**

     * @return

     *         Gets the version of the package.

     */

    public String getVersion();

    public void setVersion(String version);

    /**

     * @return

     *         Gets the build number of the package.

     */

    public int getBuild();

    public void setBuild(int build);

    /**

     * @return

     *         Gets the state of the package.

     * @see STATE

     */

    public String getState();

    /**

     * Sets the state of the package

     * 

     * @param state

     * @see STATE

     */

    public void setState(String state);

    /**

     * @return

     *         Gets if the package is official.

     */

    public boolean isOfficial();

    public void setOfficial(boolean official);

    /**

     * @return

     *         Gets the type of the package.

     */

    public String getType();

    public void setType(String type);

    /**

     * Returns the supported operating system.

     * 

     * @return the supported operating system

     * @see OS

     */

    public String getOperatingSystem();

    /**

     * Sets the supported operating system.

     * 

     * @param operatingSystem

     *            the supported operating system

     * @see OS

     */

    public void setOperatingSystem(String operatingSystem);

    /**

     * Returns the supported hardware architecture.

     * 

     * @return the supported hardware architecture

     * @see ARCH

     */

    public String getArchitecture();

    /**

     * Sets the supported hardware architecture.

     * 

     * @param architecture

     *            the supported hardware architecture

     * @see ARCH

     */

    public void setArchitecture(String architecture);

    /**

     * Returns the supported java vm version.

     * 

     * @return the supported java vm version

     * @see JVM

     */

    public String getJavaVM();

    /**

     * Sets the supported java vm version.

     * 

     * @param javaVM

     *            the supported java vm version

     * @see JVM

     */

    public void setJavaVM(String javaVM);

    public String getGvSIGVersion();

    public void setGvSIGVersion(String gvSIGVersion);

    /**

     * Add an external file that have to be copied in the

     * installation process.

     * 

     * @param file

     *            The file to copy.

     * @deprecated

     *             This method will be deleted on next releases because

     *             all the files that a plugin needs to work should be

     *             contained in its directory.

     */

    @Deprecated

    public void addFileToCopy(File file);

    /**

     * Gets one external file that is copied on

     * the installation process.

     * 

     * @param index

     *            The position of the external file.

     * @return

     *         The file that have to be copied.

     * @deprecated

     *             This method will be deleted on next releases because

     *             all the files that a plugin needs to work should be

     *             contained in its directory.

     */

    @Deprecated

    public File getFileToCopyAt(int index);

    /**

     * Gest the number of external files that have to be

     * copied in the installation process.

     * 

     * @return

     *         The number of files.

     * @deprecated

     *             This method will be deleted on next releases because

     *             all the files that a plugin needs to work should be

     *             contained in its directory.

     */

    @Deprecated

    public int getFileToCopySize();

    /**

     * Removes one of the files that have to be copied in the

     * installation process.

     * 

     * @param index

     *            the position of the file.

     * @deprecated

     *             This method will be deleted on next releases because

     *             all the files that a package needs to work should be

     *             contained in its directory.

     */

    @Deprecated

    public void removeFileToCopy(int index);

    /**

     * Sets the ant script that can be executed in the

     * installation process.

     * 

     * @param antScript

     *            The ant script to copy.

     * @deprecated

     *             This method will be deleted on next releases because

     *             all the files that a package needs to work should be

     *             contained in its directory.

     */

    @Deprecated

    public void setAnScript(String antScript);

    /**

     * Gets the ant script that has to be executed in the

     * installation process.

     * 

     * @return

     *         the script.

     * @deprecated

     *             This method will be deleted on next releases because

     *             all the files that a package needs to work should be

     *             contained in its directory.

     */

    @Deprecated

    public String getAntScript();

}