com.opensymphony.workflow.loader
Class StepDescriptor

java.lang.Object
  extended by com.opensymphony.workflow.loader.AbstractDescriptor
      extended by com.opensymphony.workflow.loader.StepDescriptor
All Implemented Interfaces:
Validatable, XMLizable, Serializable

public class StepDescriptor
extends AbstractDescriptor
implements Validatable

Author:
Pat Lightbody
See Also:
Serialized Form

Field Summary
protected  List actions
           
protected  List commonActions
          this list maintained internally to allow for proper xml serialization.
protected  boolean hasActions
           
protected  Map metaAttributes
           
protected  String name
           
protected  List permissions
           
protected  List postFunctions
           
protected  List preFunctions
           
 
Fields inherited from interface com.opensymphony.workflow.util.XMLizable
INDENT
 
Method Summary
 ActionDescriptor getAction(int id)
           
 List getActions()
          Get a List of ActionDescriptors for this step
 List getCommonActions()
          Get a list of common actions.
 Map getMetaAttributes()
           
 String getName()
           
 List getPermissions()
          Get a List of PermissionDescriptors for this step
 List getPostFunctions()
           
 List getPreFunctions()
           
protected  void init(org.w3c.dom.Element step)
           
 void removeActions()
          Remove all common and regular actions for this step.
 boolean resultsInJoin(int join)
           
 void setMetaAttributes(Map metaAttributes)
           
 void setName(String name)
           
 void setPostFunctions(List postFunctions)
           
 void setPreFunctions(List preFunctions)
           
 void validate()
          Validate this element, and propagate validation to all contained sub-elements.
 void writeXML(PrintWriter out, int indent)
           
 
Methods inherited from class com.opensymphony.workflow.loader.AbstractDescriptor
asXML, getEntityId, getId, getParent, hasId, setEntityId, setId, setParent
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

actions

protected List actions

commonActions

protected List commonActions
this list maintained internally to allow for proper xml serialization. All common-action elements in the XML file are expanded into ActionDescriptors and are available via getActions()


permissions

protected List permissions

postFunctions

protected List postFunctions

preFunctions

protected List preFunctions

metaAttributes

protected Map metaAttributes

name

protected String name

hasActions

protected boolean hasActions
Method Detail

getAction

public ActionDescriptor getAction(int id)

getActions

public List getActions()
Get a List of ActionDescriptors for this step


getCommonActions

public List getCommonActions()
Get a list of common actions.

Returns:
a List of Integer action id's.

setMetaAttributes

public void setMetaAttributes(Map metaAttributes)

getMetaAttributes

public Map getMetaAttributes()

setName

public void setName(String name)

getName

public String getName()

getPermissions

public List getPermissions()
Get a List of PermissionDescriptors for this step


setPostFunctions

public void setPostFunctions(List postFunctions)

getPostFunctions

public List getPostFunctions()

setPreFunctions

public void setPreFunctions(List preFunctions)

getPreFunctions

public List getPreFunctions()

removeActions

public void removeActions()
Remove all common and regular actions for this step.


resultsInJoin

public boolean resultsInJoin(int join)

validate

public void validate()
              throws InvalidWorkflowDescriptorException
Description copied from interface: Validatable
Validate this element, and propagate validation to all contained sub-elements. Should throw an InvalidWorkflowDescriptorException with details in message if the element is invalid. Validity checks should be checks that cannot be encapsulated in the DTD. Validation has to be called explicitly on writting, a writeXML() does not validate implicitly; it *IS* thus possible to write invalid descriptor files. This could be useful for e.g. a graphical workflow definition editor which would like to write incomplete definitions. Validation *IS* performed on loading a workflow definition.

Specified by:
validate in interface Validatable
Throws:
InvalidWorkflowDescriptorException
See Also:
WorkflowLoader.load(java.io.InputStream)

writeXML

public void writeXML(PrintWriter out,
                     int indent)
Specified by:
writeXML in interface XMLizable

init

protected void init(org.w3c.dom.Element step)

OpenSymphony Workflow Project Page