|
Faceted Project Framework Version 1.3 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
public interface IActionDefinition
An action is an operation on a single facet within a faceted project to install, uninstall, or change the version of the facet. An action definition represents the information supplied by the facet author regarding the implementation of an action. A single action definition can apply to multiple facet versions. For instance, the facet author may choose to supply one action definition for all versions of his facet.
| Field Summary | |
|---|---|
static String |
PROP_FROM_VERSIONS
The name of the property that's used to constrain the starting version of the VERSION_CHANGE action definition. |
| Method Summary | |
|---|---|
Object |
createConfigObject()
Creates a new config object that can be used for parameterizing the execution of this action. |
Object |
createConfigObject(IProjectFacetVersion fv,
String pjname)
Deprecated. |
IFacetedProject.Action.Type |
getActionType()
Returns the action type, such as INSTALL, UNINSTALL,
or VERSION_CHANGE. |
String |
getId()
Returns the id of the action definition. |
IProjectFacet |
getProjectFacet()
Returns the project facet that this action definition is associated with. |
Map<String,Object> |
getProperties()
Returns the properties that further specify action behavior and applicability. |
Object |
getProperty(String name)
Returns the property value corresponding to the provided name. |
IVersionExpr |
getVersionExpr()
Returns the version expression that controls which facet versions this action definition applies to. |
| Field Detail |
|---|
static final String PROP_FROM_VERSIONS
| Method Detail |
|---|
String getId()
IProjectFacet getProjectFacet()
IVersionExpr getVersionExpr()
IFacetedProject.Action.Type getActionType()
INSTALL, UNINSTALL,
or VERSION_CHANGE.
Map<String,Object> getProperties()
Object getProperty(String name)
name - the name of the property
Object createConfigObject()
throws CoreException
null.
CoreException - if failed while instantiating the config object
factory or creating the config object
Object createConfigObject(IProjectFacetVersion fv,
String pjname)
throws CoreException
null.
fv - the actual facet version that this config object will be used
with; should be one of the versions matched by the version expression
specified for this action definitionpjname - the project name
CoreException - if failed while instantiating the config object
factory or creating the config object
|
Faceted Project Framework Version 1.3 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||