|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface WorkflowComponent
WorkflowComponents are components that can be executed by the Model Workflow Engine.
The Workflow Engine will call the
#invoke(WorkflowContext, ProgressMonitor)
method at the appropriate
time to execute the component's service.
Method Summary | |
---|---|
void |
checkConfiguration(Issues issues)
Called by the container after configuration so the component can validate the configuration before invocation. |
java.lang.String |
getComponentName()
Returns the name of the component. |
CompositeComponent |
getContainer()
Returns the containing component if there is one. |
Location |
getLocation()
Returns the location in the source file that invokes the current component. |
void |
invoke(WorkflowContext ctx,
ProgressMonitor monitor,
Issues issues)
Invokes the component. |
void |
setContainer(CompositeComponent container)
Sets the containing component. |
void |
setLocation(Location location)
Sets the location in the source file that invokes the current component. |
Method Detail |
---|
void invoke(WorkflowContext ctx, ProgressMonitor monitor, Issues issues)
ctx
- current workflow contextmonitor
- implementors should provide some feedback about the progress
using this monitorissues
- void checkConfiguration(Issues issues)
issues
- implementors should report configuration issues to this.CompositeComponent getContainer()
void setContainer(CompositeComponent container)
container
- the containing componentvoid setLocation(Location location)
location
- the locationLocation getLocation()
java.lang.String getComponentName()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |