001/*
002 * (C) Copyright 2006-2010 Nuxeo SA (http://nuxeo.com/) and contributors.
003 *
004 * All rights reserved. This program and the accompanying materials
005 * are made available under the terms of the GNU Lesser General Public License
006 * (LGPL) version 2.1 which accompanies this distribution, and is available at
007 * http://www.gnu.org/licenses/lgpl.html
008 *
009 * This library is distributed in the hope that it will be useful,
010 * but WITHOUT ANY WARRANTY; without even the implied warranty of
011 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
012 * Lesser General Public License for more details.
013 *
014 * Contributors:
015 *     Thierry Delprat
016 */
017package org.nuxeo.apidoc.snapshot;
018
019import java.util.List;
020
021import org.nuxeo.apidoc.api.BundleGroup;
022import org.nuxeo.apidoc.api.BundleInfo;
023import org.nuxeo.apidoc.api.ComponentInfo;
024import org.nuxeo.apidoc.api.ExtensionInfo;
025import org.nuxeo.apidoc.api.ExtensionPointInfo;
026import org.nuxeo.apidoc.api.OperationInfo;
027import org.nuxeo.apidoc.api.SeamComponentInfo;
028import org.nuxeo.apidoc.api.ServiceInfo;
029import org.nuxeo.apidoc.documentation.JavaDocHelper;
030
031public interface DistributionSnapshot extends DistributionSnapshotDesc {
032
033    String TYPE_NAME = "NXDistribution";
034
035    String CONTAINER_TYPE_NAME = "Workspace";
036
037    String PROP_NAME = "nxdistribution:name";
038
039    String PROP_VERSION = "nxdistribution:version";
040
041    String PROP_KEY = "nxdistribution:key";
042
043    String getKey();
044
045    void cleanPreviousArtifacts();
046
047    List<BundleGroup> getBundleGroups();
048
049    BundleGroup getBundleGroup(String groupId);
050
051    List<String> getBundleIds();
052
053    BundleInfo getBundle(String id);
054
055    List<String> getComponentIds();
056
057    List<String> getJavaComponentIds();
058
059    List<String> getXmlComponentIds();
060
061    ComponentInfo getComponent(String id);
062
063    List<String> getServiceIds();
064
065    ServiceInfo getService(String id);
066
067    List<String> getExtensionPointIds();
068
069    ExtensionPointInfo getExtensionPoint(String id);
070
071    List<String> getContributionIds();
072
073    List<ExtensionInfo> getContributions();
074
075    ExtensionInfo getContribution(String id);
076
077    List<String> getBundleGroupChildren(String groupId);
078
079    List<Class<?>> getSpi();
080
081    List<String> getSeamComponentIds();
082
083    List<SeamComponentInfo> getSeamComponents();
084
085    SeamComponentInfo getSeamComponent(String id);
086
087    boolean containsSeamComponents();
088
089    OperationInfo getOperation(String id);
090
091    List<OperationInfo> getOperations();
092
093    JavaDocHelper getJavaDocHelper();
094}