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.List;
023
024import com.fasterxml.jackson.annotation.JsonManagedReference;
025
026import org.nuxeo.apidoc.documentation.ContributionItem;
027import org.nuxeo.runtime.model.ComponentName;
028
029public interface ExtensionInfo extends NuxeoArtifact {
030
031    String TYPE_NAME = "NXContribution";
032
033    String PROP_CONTRIB_ID = "nxcontribution:contribId";
034
035    String PROP_DOC = "nxcontribution:documentation";
036
037    String PROP_EXTENSION_POINT = "nxcontribution:extensionPoint";
038
039    String PROP_TARGET_COMPONENT_NAME = "nxcontribution:targetComponentName";
040
041    String getExtensionPoint();
042
043    String getDocumentation();
044
045    String getDocumentationHtml();
046
047    ComponentName getTargetComponentName();
048
049    String getXml();
050
051    List<ContributionItem> getContributionItems();
052
053    @JsonManagedReference("extension")
054    ComponentInfo getComponent();
055
056}