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.io.IOException; 023import java.net.URL; 024import java.util.Collection; 025import java.util.List; 026 027public interface ComponentInfo extends NuxeoArtifact { 028 029 String TYPE_NAME = "NXComponent"; 030 031 String PROP_COMPONENT_ID = "nxcomponent:componentId"; 032 033 String PROP_COMPONENT_NAME = "nxcomponent:componentName"; 034 035 String PROP_COMPONENT_CLASS = "nxcomponent:componentClass"; 036 037 String PROP_BUILT_IN_DOC = "nxcomponent:builtInDocumentation"; 038 039 String PROP_IS_XML = "nxcomponent:isXML"; 040 041 String PROP_SERVICES = "nxcomponent:services"; 042 043 String getName(); 044 045 BundleInfo getBundle(); 046 047 Collection<ExtensionPointInfo> getExtensionPoints(); 048 049 Collection<ExtensionInfo> getExtensions(); 050 051 ExtensionPointInfo getExtensionPoint(String name); 052 053 String getDocumentation(); 054 055 String getDocumentationHtml(); 056 057 List<String> getServiceNames(); 058 059 List<ServiceInfo> getServices(); 060 061 String getComponentClass(); 062 063 boolean isXmlPureComponent(); 064 065 URL getXmlFileUrl(); 066 067 String getXmlFileName(); 068 069 String getXmlFileContent() throws IOException; 070 071}