001    /**
002     * Copyright (c) 2000-2013 Liferay, Inc. All rights reserved.
003     *
004     * This library is free software; you can redistribute it and/or modify it under
005     * the terms of the GNU Lesser General Public License as published by the Free
006     * Software Foundation; either version 2.1 of the License, or (at your option)
007     * any later version.
008     *
009     * This library is distributed in the hope that it will be useful, but WITHOUT
010     * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
011     * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
012     * details.
013     */
014    
015    package com.liferay.portal.kernel.plugin;
016    
017    import java.util.Date;
018    import java.util.List;
019    import java.util.Properties;
020    
021    /**
022     * @author Jorge Ferrer
023     * @author Brian Wing Shun Chan
024     */
025    public interface PluginPackage {
026    
027            public static final String REPOSITORY_XML_FILENAME_EXTENSION = "xml";
028    
029            public static final String REPOSITORY_XML_FILENAME_PREFIX =
030                    "liferay-plugin-repository";
031    
032            public String getArtifactId();
033    
034            public String getArtifactURL();
035    
036            public String getAuthor();
037    
038            public String getChangeLog();
039    
040            public String getContext();
041    
042            public Properties getDeploymentSettings();
043    
044            public String getDownloadURL();
045    
046            public String getGroupId();
047    
048            public List<License> getLicenses();
049    
050            public List<String> getLiferayVersions();
051    
052            public String getLongDescription();
053    
054            public Date getModifiedDate();
055    
056            public String getModuleId();
057    
058            public String getName();
059    
060            public String getPackageId();
061    
062            public String getPageURL();
063    
064            public String getRecommendedDeploymentContext();
065    
066            public RemotePluginPackageRepository getRepository();
067    
068            public String getRepositoryURL();
069    
070            List<String> getRequiredDeploymentContexts();
071    
072            public List<Screenshot> getScreenshots();
073    
074            public String getShortDescription();
075    
076            public List<String> getTags();
077    
078            public List<String> getTypes();
079    
080            public String getVersion();
081    
082            public boolean isLaterVersionThan(PluginPackage pluginPackage);
083    
084            public boolean isPreviousVersionThan(PluginPackage pluginPackage);
085    
086            public boolean isSameVersionAs(PluginPackage pluginPackage);
087    
088            public void setAuthor(String author);
089    
090            public void setChangeLog(String changeLog);
091    
092            public void setContext(String context);
093    
094            public void setDeploymentSettings(Properties properties);
095    
096            public void setDownloadURL(String downloadURL);
097    
098            public void setLicenses(List<License> licenses);
099    
100            public void setLiferayVersions(List<String> liferayVersions);
101    
102            public void setLongDescription(String longDescription);
103    
104            public void setModifiedDate(Date modifiedDate);
105    
106            public void setName(String name);
107    
108            public void setPageURL(String pageURL);
109    
110            public void setRecommendedDeploymentContext(String deploymentContext);
111    
112            public void setRepository(RemotePluginPackageRepository repository);
113    
114            public void setRequiredDeploymentContexts(
115                    List<String> requiredDeploymentContexts);
116    
117            public void setScreenshots(List<Screenshot> screenshots);
118    
119            public void setShortDescription(String shortDescription);
120    
121            public void setTags(List<String> tags);
122    
123            public void setTypes(List<String> types);
124    
125    }