com.webmethods.bpm.process
Interface IBpmProcessDefinition


public interface IBpmProcessDefinition

Interface which represents process definition for ad-hoc workflow


Method Summary
 IBpmProcessStepDefinition createStep(String stepID)
          Creates a new step definition for this process
 IBpmProcessTransitionDefinition createTransition(String fromStepID, String toStepID)
          Creates a new transition definition between steps
 void deleteStep(String stepID)
          Removes step definition by its ID
 void deleteTransition(String fromStepID, String toStepID)
          Removes transition definition between steps
 void generateProcessFile()
          Generates process file for this process definition
 String getDescription()
          Returns description for process definition
 String getID()
          Unique ID (key) for this process definition
 String getName()
          Returns name for process definition
 String getProcessFile()
          Returns xml for generated .process layout file
 IBpmProcessStepDefinition getStartStep()
          Finds start step for this process
 IBpmProcessStepDefinition getStep(String stepID)
          Returns a single step by its ID
 List getSteps()
          Returns list of declared steps
 List getTransitions()
          Returns list of declared transitions
 void layout(int direction)
          Re-Generates process layout
 void setDescription(String description)
          Sets description for process definition
 void setName(String name)
          Sets name for process definition
 

Method Detail

getID

String getID()
Unique ID (key) for this process definition


getName

String getName()
Returns name for process definition


setName

void setName(String name)
Sets name for process definition

Parameters:
name -

getDescription

String getDescription()
Returns description for process definition


setDescription

void setDescription(String description)
Sets description for process definition

Parameters:
description -

getSteps

List getSteps()
Returns list of declared steps


getTransitions

List getTransitions()
Returns list of declared transitions


getStep

IBpmProcessStepDefinition getStep(String stepID)
Returns a single step by its ID

Parameters:
stepID -

getStartStep

IBpmProcessStepDefinition getStartStep()
Finds start step for this process


createStep

IBpmProcessStepDefinition createStep(String stepID)
Creates a new step definition for this process

Parameters:
stepID -

deleteStep

void deleteStep(String stepID)
Removes step definition by its ID

Parameters:
stepID -

createTransition

IBpmProcessTransitionDefinition createTransition(String fromStepID,
                                                 String toStepID)
Creates a new transition definition between steps

Parameters:
fromStepID -
toStepID -

deleteTransition

void deleteTransition(String fromStepID,
                      String toStepID)
Removes transition definition between steps

Parameters:
fromStepID -
toStepID -

layout

void layout(int direction)
            throws Exception
Re-Generates process layout

Parameters:
direction - see com.webmethods.process.model.layout.geometryPositionConstants
Throws:
Exception

generateProcessFile

void generateProcessFile()
                         throws Exception
Generates process file for this process definition

Throws:
Exception

getProcessFile

String getProcessFile()
Returns xml for generated .process layout file

Returns: