|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.commons.workflow.base.BaseStep
public abstract class BaseStep
BaseStep is a convenient base class for more sophisticated
Step
implementations. It includes management of the static
relationships of Steps to each other, and to their owning Activity, but
requires the implementation to provide an execute()
method.
Field Summary | |
---|---|
protected String |
id
The unique identifier (within this Activity) of this Step. |
protected Step |
nextStep
The next Step in our associated Activity. |
protected Owner |
owner
The Activity or Block that owns this Step. |
protected Step |
previousStep
The previous Step in our associated Activity. |
Constructor Summary | |
---|---|
BaseStep()
|
Method Summary | |
---|---|
abstract void |
execute(Context context)
Perform the executable actions related to this Step, in the context of the specified Context. |
String |
getId()
Return the unique identifier (within this Activity or Block) of this Step. |
Step |
getNextStep()
Return the next Step in our associated Activity or Block. |
Owner |
getOwner()
Return the Activity or Block that owns this Step. |
Step |
getPreviousStep()
Return the previous Step in our associated Activity or Block. |
void |
setId(String id)
Set the unique identifier (within this Activity or Block) of this Step. |
void |
setNextStep(Step nextStep)
Set the next Step in our associated Activity or Block. |
void |
setOwner(Owner owner)
Set the Activity or Block that owns this Step. |
void |
setPreviousStep(Step previousStep)
Set the previous Step in our associated Activity or Block. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected String id
protected Step nextStep
protected Owner owner
protected Step previousStep
Constructor Detail |
---|
public BaseStep()
Method Detail |
---|
public String getId()
getId
in interface Step
public void setId(String id)
setId
in interface Step
id
- The new unique identifierpublic Step getNextStep()
getNextStep
in interface Step
public void setNextStep(Step nextStep)
setNextStep
in interface Step
nextStep
- The new next Steppublic Owner getOwner()
getOwner
in interface Step
public void setOwner(Owner owner)
setOwner
in interface Step
owner
- The new owning Activity or Blockpublic Step getPreviousStep()
getPreviousStep
in interface Step
public void setPreviousStep(Step previousStep)
setPreviousStep
in interface Step
previousStep
- The new previous Steppublic abstract void execute(Context context) throws StepException
execute
in interface Step
context
- The Context that is tracking our execution state
StepException
- if a processing error has occurred
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |