|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.openarchitectureware.workflow.lib.AbstractWorkflowComponent
public abstract class AbstractWorkflowComponent
Base class useful for implementing custom WorkflowComponents.
Constructor Summary | |
---|---|
AbstractWorkflowComponent()
|
Method Summary | |
---|---|
void |
checkRequiredConfigProperty(java.lang.String configPropertyName,
java.lang.Object configPropertyValue,
Issues issues)
Utility method that can be used in method checkConfiguration
to check required properties. |
java.lang.String |
getComponentName()
Override this method by custom components. |
CompositeComponent |
getContainer()
Returns the containing component, if there is one. |
java.lang.String |
getId()
Returns the ID of the component. |
Location |
getLocation()
Returns the location in the source file that invokes the current component. |
java.lang.String |
getLogMessage()
Returns the log message, |
void |
setContainer(CompositeComponent container)
Sers the containing component. |
void |
setId(java.lang.String id)
Sets the ID of the workflow component. |
void |
setLocation(Location location)
Sets the location in the source file that invokes the current component. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.openarchitectureware.workflow.WorkflowComponent |
---|
checkConfiguration, invoke |
Constructor Detail |
---|
public AbstractWorkflowComponent()
Method Detail |
---|
public java.lang.String getId()
WorkflowComponentWithID
getId
in interface WorkflowComponentWithID
WorkflowComponentWithID.getId()
public void setId(java.lang.String id)
WorkflowComponentWithID
setId
in interface WorkflowComponentWithID
id
- the IDWorkflowComponentWithID.setId(java.lang.String)
public CompositeComponent getContainer()
WorkflowComponent
getContainer
in interface WorkflowComponent
WorkflowComponent.getContainer()
public void setContainer(CompositeComponent container)
WorkflowComponent
setContainer
in interface WorkflowComponent
container
- The containing componentpublic java.lang.String getLogMessage()
WorkflowComponentWithID
getLogMessage
in interface WorkflowComponentWithID
WorkflowComponentWithID.getLogMessage()
public Location getLocation()
WorkflowComponent
getLocation
in interface WorkflowComponent
WorkflowComponent.getLocation()
public void setLocation(Location location)
WorkflowComponent
setLocation
in interface WorkflowComponent
location
- the locationWorkflowComponent.setLocation(org.openarchitectureware.workflow.ast.parser.Location)
public java.lang.String getComponentName()
getComponentName
in interface WorkflowComponent
public void checkRequiredConfigProperty(java.lang.String configPropertyName, java.lang.Object configPropertyValue, Issues issues)
checkConfiguration
to check required properties. If configPropertyValue
is
null
or a blank string then this method will add an error
issue.
configPropertyName
- Name of the checked config property.configPropertyValue
- The config property value.issues
- The Issues instance.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |