org.openarchitectureware.workflow
Interface WorkflowComponent

All Known Subinterfaces:
WorkflowComponentWithID
All Known Implementing Classes:
AbstractExpressionsUsingWorkflowAdvice, AbstractExpressionsUsingWorkflowComponent, AbstractWorkflowAdvice, AbstractWorkflowComponent, AbstractWorkflowComponent2, CheckComponent, CompilationUnitInstantiator, CompositeComponent, ConditionalComponent, DirectoryCleaner, FeatureComponent, Generator, GeneratorAdvice, IfComponent, PassiveWorkflowComponent, SimpleJavaModificationComponent, SimpleJavaTransformationComponent, Workflow, WorkflowComponentWithModelSlot, XtendAdvice, XtendComponent

public interface WorkflowComponent

WorkflowComponents are components that can be executed by the openArchitectureWare Workflow Engine.

The Workflow Engine will call the #invoke(WorkflowContext, ProgressMonitor) method at the appropriate time to execute the component's service.

Author:
Sven Efftinge (http://www.efftinge.de)

Method Summary
 void checkConfiguration(Issues issues)
          Validates 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 workflow component.
 void setContainer(CompositeComponent container)
          Sers the containing component.
 void setLocation(Location location)
          Sets the location in the source file that invokes the current component.
 

Method Detail

invoke

void invoke(WorkflowContext ctx,
            ProgressMonitor monitor,
            Issues issues)
Invokes the workflow component.

Parameters:
ctx - the current workflow context
monitor - implementors should provide some feedback about the progress using this monitor
issues - facility for reporting possible issues that occur during invocation

checkConfiguration

void checkConfiguration(Issues issues)
Validates the configuration before invocation.

Parameters:
issues - facility for reporting configuration issues.

getContainer

CompositeComponent getContainer()
Returns the containing component, if there is one.

Returns:
the container

setContainer

void setContainer(CompositeComponent container)
Sers the containing component.

Parameters:
container - the containing component

setLocation

void setLocation(Location location)
Sets the location in the source file that invokes the current component.

Parameters:
location - the location

getLocation

Location getLocation()
Returns the location in the source file that invokes the current component.

Returns:
the location

getComponentName

java.lang.String getComponentName()
Returns the name of the component.

Returns:
the component name
Since:
4.3.1