001/*
002 * (C) Copyright 2006-2010 Nuxeo SA (http://nuxeo.com/) and others.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 *
016 * Contributors:
017 *     Bogdan Stefanescu
018 *     Thierry Delprat
019 */
020package org.nuxeo.apidoc.api;
021
022import java.util.Collection;
023import java.util.Map;
024
025import org.nuxeo.apidoc.documentation.ResourceDocumentationItem;
026
027import com.fasterxml.jackson.annotation.JsonBackReference;
028
029public interface BundleInfo extends NuxeoArtifact {
030
031    String TYPE_NAME = "NXBundle";
032
033    String PROP_ARTIFACT_GROUP_ID = "nxbundle:artifactGroupId";
034
035    String PROP_ARTIFACT_ID = "nxbundle:artifactId";
036
037    String PROP_ARTIFACT_VERSION = "nxbundle:artifactVersion";
038
039    String PROP_BUNDLE_ID = "nxbundle:bundleId";
040
041    String PROP_JAR_NAME = "nxbundle:jarName";
042
043    @JsonBackReference("component")
044    Collection<ComponentInfo> getComponents();
045
046    String getFileName();
047
048    String getBundleId();
049
050    String[] getRequirements();
051
052    String getManifest();
053
054    String getLocation();
055
056    String getGroupId();
057
058    String getArtifactId();
059
060    String getArtifactVersion();
061
062    Map<String, ResourceDocumentationItem> getLiveDoc();
063
064    Map<String, ResourceDocumentationItem> getParentLiveDoc();
065
066}