|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.opensymphony.workflow.loader.AbstractDescriptor
com.opensymphony.workflow.loader.WorkflowDescriptor
public class WorkflowDescriptor
Describes a single workflow
| Field Summary | |
|---|---|
protected Map |
commonActions
|
protected List |
commonActionsList
|
static String |
DOCTYPE_DECL
|
protected List |
globalActions
|
protected ConditionsDescriptor |
globalConditions
|
protected List |
initialActions
|
protected List |
joins
|
protected Map |
metaAttributes
|
protected List |
registers
|
protected List |
splits
|
protected List |
steps
|
protected Map |
timerFunctions
|
protected String |
workflowName
|
static String |
XML_HEADER
|
| Fields inherited from interface com.opensymphony.workflow.util.XMLizable |
|---|
INDENT |
| Constructor Summary | |
|---|---|
WorkflowDescriptor()
Deprecated. use DescriptorFactory instead |
|
WorkflowDescriptor(org.w3c.dom.Element root)
Deprecated. use DescriptorFactory instead |
|
| Method Summary | |
|---|---|
void |
addCommonAction(ActionDescriptor descriptor)
Add a common action |
void |
addGlobalAction(ActionDescriptor descriptor)
Add a global action |
void |
addInitialAction(ActionDescriptor descriptor)
Add an initial action |
void |
addJoin(JoinDescriptor descriptor)
Add a join |
void |
addSplit(SplitDescriptor descriptor)
Add a split |
void |
addStep(StepDescriptor descriptor)
Add a step |
ActionDescriptor |
getAction(int id)
|
Map |
getCommonActions()
Get a Map of the common actions specified, keyed on actionId (an Integer) |
List |
getGlobalActions()
Get a List of the global actions specified |
ConditionsDescriptor |
getGlobalConditions()
|
ActionDescriptor |
getInitialAction(int id)
|
List |
getInitialActions()
Get a List of initial steps for this workflow |
JoinDescriptor |
getJoin(int id)
|
List |
getJoins()
Get a List of initial steps for this workflow |
Map |
getMetaAttributes()
|
String |
getName()
|
List |
getRegisters()
|
SplitDescriptor |
getSplit(int id)
|
List |
getSplits()
Get a List of initial steps for this workflow |
StepDescriptor |
getStep(int id)
|
List |
getSteps()
Get a List of steps in this workflow |
FunctionDescriptor |
getTriggerFunction(int id)
|
Map |
getTriggerFunctions()
Get a Map of all trigger functions in this workflow |
protected void |
init(org.w3c.dom.Element root)
|
boolean |
removeAction(ActionDescriptor actionToRemove)
Remove an action from this workflow completely. |
void |
setName(String name)
|
FunctionDescriptor |
setTriggerFunction(int id,
FunctionDescriptor descriptor)
Update a trigger function |
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 |
|---|
public static final String XML_HEADER
public static final String DOCTYPE_DECL
protected ConditionsDescriptor globalConditions
protected List commonActionsList
protected List globalActions
protected List initialActions
protected List joins
protected List registers
protected List splits
protected List steps
protected Map commonActions
protected Map metaAttributes
protected Map timerFunctions
protected String workflowName
| Constructor Detail |
|---|
public WorkflowDescriptor()
DescriptorFactory instead
public WorkflowDescriptor(org.w3c.dom.Element root)
DescriptorFactory instead
| Method Detail |
|---|
public ActionDescriptor getAction(int id)
public Map getCommonActions()
ActionDescriptor objectspublic List getGlobalActions()
ActionDescriptor objectspublic ConditionsDescriptor getGlobalConditions()
public ActionDescriptor getInitialAction(int id)
public List getInitialActions()
ActionDescriptor objectspublic JoinDescriptor getJoin(int id)
public List getJoins()
JoinDescriptor objectspublic Map getMetaAttributes()
public void setName(String name)
public String getName()
public List getRegisters()
public SplitDescriptor getSplit(int id)
public List getSplits()
SplitDescriptor objectspublic StepDescriptor getStep(int id)
public List getSteps()
StepDescriptor objects
public FunctionDescriptor setTriggerFunction(int id,
FunctionDescriptor descriptor)
id - The id for the trigger functiondescriptor - The descriptor for the trigger function
public FunctionDescriptor getTriggerFunction(int id)
public Map getTriggerFunctions()
FunctionDescriptor valuespublic void addCommonAction(ActionDescriptor descriptor)
descriptor - The action descriptor to add
IllegalArgumentException - if the descriptor's ID already exists in the workflowpublic void addGlobalAction(ActionDescriptor descriptor)
descriptor - The action descriptor to add
IllegalArgumentException - if the descriptor's ID already exists in the workflowpublic void addInitialAction(ActionDescriptor descriptor)
descriptor - The action descriptor to add
IllegalArgumentException - if the descriptor's ID already exists in the workflowpublic void addJoin(JoinDescriptor descriptor)
descriptor - The join descriptor to add
IllegalArgumentException - if the descriptor's ID already exists in the workflowpublic void addSplit(SplitDescriptor descriptor)
descriptor - The split descriptor to add
IllegalArgumentException - if the descriptor's ID already exists in the workflowpublic void addStep(StepDescriptor descriptor)
descriptor - The step descriptor to add
IllegalArgumentException - if the descriptor's ID already exists in the workflowpublic boolean removeAction(ActionDescriptor actionToRemove)
This method will check global actions and all steps.
public void validate()
throws InvalidWorkflowDescriptorException
Validatable
validate in interface ValidatableInvalidWorkflowDescriptorExceptionWorkflowLoader.load(java.io.InputStream)
public void writeXML(PrintWriter out,
int indent)
writeXML in interface XMLizableprotected void init(org.w3c.dom.Element root)
|
OpenSymphony Workflow Project Page | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||