com.webmethods.bpm.process
Interface IBpmProcess


public interface IBpmProcess

Represents Ad-hoc workflow process instance


Field Summary
static int PROCESS_STATUS_CANCELLED
          Process cancelled
static int PROCESS_STATUS_ENDED
          Process successfully completed
static int PROCESS_STATUS_FAILED
          Process failed
static int PROCESS_STATUS_RESUMED
          Process Resumed
static int PROCESS_STATUS_STARTED
          Process started and running
static int PROCESS_STATUS_SUSPENDED
          Process suspended
static int PROCESS_STATUS_UNDEFINED
          Process status underfined (for newly created processes)
 
Method Summary
 void addError(String errorMessage, String errorStackTrace, String serviceName)
          Adds error to this step
 IBpmProcessStep addStep(String stepID)
          Adds new step to the process instance
 IBpmProcessTransition addTransition(String fromStepID, String toStepID)
          Adds transition for this process instance
 void deleteStep(String stepID)
          Deletes a step from process
 String getCreatedBy()
          Returns user who created a process
 Date getCreatedDate()
          Returns process creation date
 List getErrors()
          Returns list of errors attached to this step
 String getID()
          Returns unique ID for this process instance
 String getLastModifiedBy()
          Returns user who modified a process
 Date getLastModifiedDate()
          Returns process modification date
 String getName()
          Returns name for this process instance
 String getParentProcessID()
          Returns parent process instance ID (if set)
 String getParentStepID()
          Returns parent process stepID (if set)
 IBpmProcessDefinition getProcessDefinition()
          Returns process definition for this instance
 int getStatus()
          Returns status of this process instance
 IBpmProcessStep getStep(String stepID)
          Returns step by its ID or null if not found
 List getSteps()
          Returns list of steps
 List getTransitions()
          Returns list of transitions
 void setName(String name)
          Sets name for this process instance
 void setStatus(int status)
          Sets status for process instance
 

Field Detail

PROCESS_STATUS_UNDEFINED

static final int PROCESS_STATUS_UNDEFINED
Process status underfined (for newly created processes)

See Also:
Constant Field Values

PROCESS_STATUS_STARTED

static final int PROCESS_STATUS_STARTED
Process started and running

See Also:
Constant Field Values

PROCESS_STATUS_ENDED

static final int PROCESS_STATUS_ENDED
Process successfully completed

See Also:
Constant Field Values

PROCESS_STATUS_FAILED

static final int PROCESS_STATUS_FAILED
Process failed

See Also:
Constant Field Values

PROCESS_STATUS_SUSPENDED

static final int PROCESS_STATUS_SUSPENDED
Process suspended

See Also:
Constant Field Values

PROCESS_STATUS_RESUMED

static final int PROCESS_STATUS_RESUMED
Process Resumed

See Also:
Constant Field Values

PROCESS_STATUS_CANCELLED

static final int PROCESS_STATUS_CANCELLED
Process cancelled

See Also:
Constant Field Values
Method Detail

getProcessDefinition

IBpmProcessDefinition getProcessDefinition()
                                           throws Exception
Returns process definition for this instance

Throws:
Exception

getID

String getID()
Returns unique ID for this process instance


getParentProcessID

String getParentProcessID()
Returns parent process instance ID (if set)


getParentStepID

String getParentStepID()
Returns parent process stepID (if set)


getCreatedDate

Date getCreatedDate()
Returns process creation date


getLastModifiedDate

Date getLastModifiedDate()
Returns process modification date


getCreatedBy

String getCreatedBy()
Returns user who created a process


getLastModifiedBy

String getLastModifiedBy()
Returns user who modified a process


getName

String getName()
Returns name for this process instance


setName

void setName(String name)
Sets name for this process instance


getStatus

int getStatus()
Returns status of this process instance


setStatus

void setStatus(int status)
Sets status for process instance


getStep

IBpmProcessStep getStep(String stepID)
                        throws Exception
Returns step by its ID or null if not found

Parameters:
stepID -
Throws:
Exception

addStep

IBpmProcessStep addStep(String stepID)
                        throws Exception
Adds new step to the process instance

Parameters:
stepID -
Throws:
Exception

deleteStep

void deleteStep(String stepID)
                throws Exception
Deletes a step from process

Parameters:
stepID -
Throws:
Exception

addTransition

IBpmProcessTransition addTransition(String fromStepID,
                                    String toStepID)
                                    throws Exception
Adds transition for this process instance

Parameters:
fromStepID -
toStepID -
Throws:
Exception

getTransitions

List getTransitions()
                    throws Exception
Returns list of transitions

Throws:
Exception

getSteps

List getSteps()
              throws Exception
Returns list of steps

Throws:
Exception

getErrors

List getErrors()
               throws Exception
Returns list of errors attached to this step

Throws:
Exception

addError

void addError(String errorMessage,
              String errorStackTrace,
              String serviceName)
              throws Exception
Adds error to this step

Throws:
Exception