bundles/org.simantics.project/src/org/simantics/project/features/registry/IProjectFeatureExtension.java

   1 /*******************************************************************************\r
   2  * Copyright (c) 2007, 2010 Association for Decentralized Information Management\r
   3  * in Industry THTH ry.\r
   4  * All rights reserved. This program and the accompanying materials\r
   5  * are made available under the terms of the Eclipse Public License v1.0\r
   6  * which accompanies this distribution, and is available at\r
   7  * http://www.eclipse.org/legal/epl-v10.html\r
   8  *\r
   9  * Contributors:\r
  10  *     VTT Technical Research Centre of Finland - initial API and implementation\r
  11  *******************************************************************************/\r
  12 package org.simantics.project.features.registry;\r
  13 \r
  14 import java.util.Collection;\r
  15 \r
  16 import org.eclipse.core.runtime.CoreException;\r
  17 import org.simantics.project.features.IProjectFeature;\r
  18 \r
  19 /**\r
  20  * @author Tuukka Lehtonen\r
  21  */\r
  22 public interface IProjectFeatureExtension {\r
  23 \r
  24     /**\r
  25      * @return id of this extension\r
  26      */\r
  27     String getId();\r
  28 \r
  29     /**\r
  30      * @return label of this extension\r
  31      */\r
  32     String getLabel();\r
  33 \r
  34     /**\r
  35      * @return description of this extension\r
  36      */\r
  37     String getDescription();\r
  38 \r
  39     /**\r
  40      * Informs whether this project feature should be published to users in UI's\r
  41      * that visualize user selectable project features in some manner.\r
  42      * \r
  43      * For example top level project features should always be published in\r
  44      * order to give Simantics Project Manager users the possibility to select\r
  45      * the feature to be used in their project.\r
  46      * \r
  47      * @return <code>true</code> if the extension is published\r
  48      */\r
  49     boolean isPublished();\r
  50 \r
  51     /**\r
  52      * @return\r
  53      */\r
  54     Collection<ProjectFeatureReference> requires();\r
  55 \r
  56     /**\r
  57      * @return\r
  58      */\r
  59     Collection<InjectedDependency> injections();\r
  60 \r
  61     /**\r
  62      * @return\r
  63      */\r
  64     Collection<GroupReference> installGroups();\r
  65 \r
  66     /**\r
  67      * @return a new instance of the IProjectFeature described by this extension\r
  68      */\r
  69     IProjectFeature newInstance() throws CoreException;\r
  70 \r
  71 }\r