|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.opensymphony.workflow.loader.AbstractWorkflowFactory
com.opensymphony.workflow.loader.XMLWorkflowFactory
public class XMLWorkflowFactory
| Field Summary | |
|---|---|
protected boolean |
reload
|
protected Map |
workflows
|
| Fields inherited from class com.opensymphony.workflow.loader.AbstractWorkflowFactory |
|---|
properties |
| Constructor Summary | |
|---|---|
XMLWorkflowFactory()
|
|
| Method Summary | |
|---|---|
void |
createWorkflow(String name)
|
protected String |
getBaseDir(org.w3c.dom.Element root)
Get where to find workflow XML files. |
protected InputStream |
getInputStream(String name)
Load the workflow config file from the current context classloader. |
Object |
getLayout(String workflowName)
|
String |
getName()
|
WorkflowDescriptor |
getWorkflow(String name,
boolean validate)
Get a workflow descriptor given a workflow name. |
String[] |
getWorkflowNames()
Get all workflow names in the current factory |
void |
initDone()
Invoked after the properties of the factory have been set. |
boolean |
isModifiable(String name)
|
boolean |
removeWorkflow(String name)
|
void |
renameWorkflow(String oldName,
String newName)
|
void |
save()
|
boolean |
saveWorkflow(String name,
WorkflowDescriptor descriptor,
boolean replace)
Save the workflow. |
void |
setLayout(String workflowName,
Object layout)
|
protected void |
writeXML(WorkflowDescriptor descriptor,
Writer out)
|
| Methods inherited from class com.opensymphony.workflow.loader.AbstractWorkflowFactory |
|---|
getProperties, getWorkflow, init |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
protected Map workflows
protected boolean reload
| Constructor Detail |
|---|
public XMLWorkflowFactory()
| Method Detail |
|---|
public void setLayout(String workflowName,
Object layout)
setLayout in interface WorkflowFactorypublic Object getLayout(String workflowName)
getLayout in interface WorkflowFactorypublic boolean isModifiable(String name)
isModifiable in interface WorkflowFactorypublic String getName()
getName in interface WorkflowFactory
public WorkflowDescriptor getWorkflow(String name,
boolean validate)
throws FactoryException
WorkflowFactory
getWorkflow in interface WorkflowFactoryname - The name of the workflow to get.
FactoryException - if the specified workflow name does not exist or cannot be located.public String[] getWorkflowNames()
WorkflowFactory
getWorkflowNames in interface WorkflowFactorypublic void createWorkflow(String name)
createWorkflow in interface WorkflowFactory
public void initDone()
throws FactoryException
AbstractWorkflowFactory
initDone in interface WorkflowFactoryinitDone in class AbstractWorkflowFactoryFactoryException - if there was an error during initialization.
public boolean removeWorkflow(String name)
throws FactoryException
removeWorkflow in interface WorkflowFactoryFactoryException
public void renameWorkflow(String oldName,
String newName)
renameWorkflow in interface WorkflowFactorypublic void save()
save in interface WorkflowFactory
public boolean saveWorkflow(String name,
WorkflowDescriptor descriptor,
boolean replace)
throws FactoryException
WorkflowFactoryWorkflowDescriptor.validate() method. Invalid workflows will
be saved without being checked.
saveWorkflow in interface WorkflowFactoryname - The name of the workflow to same.descriptor - The descriptor for the workflow.replace - true if an existing workflow with this name should be replaced.
FactoryException - if there was an error saving the workflow
InvalidWorkflowDescriptorException - if the descriptor specified is invalidprotected String getBaseDir(org.w3c.dom.Element root)
root - The root element of the XML file.
protected InputStream getInputStream(String name)
protected void writeXML(WorkflowDescriptor descriptor,
Writer out)
|
OpenSymphony Workflow Project Page | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||