Package com.webmethods.bpm.process

Interface IBpmProcessStep

public interface IBpmProcessStep
Interface which represents process instance step

  • Field Details

    • STEP_STATUS_UNDEFINED

      static final int STEP_STATUS_UNDEFINED
      Step status is undefined (for newly added steps)
      See Also:

    • STEP_STATUS_STARTED

      static final int STEP_STATUS_STARTED
      Step was started
      See Also:

    • STEP_STATUS_ENDED

      static final int STEP_STATUS_ENDED
      Step successfully completed
      See Also:

    • STEP_STATUS_FAILED

      static final int STEP_STATUS_FAILED
      Step failed
      See Also:

    • STEP_STATUS_SUSPENDED

      static final int STEP_STATUS_SUSPENDED
      Process suspended
      See Also:

    • STEP_STATUS_RESUMED

      static final int STEP_STATUS_RESUMED
      Process Resumed
      See Also:

    • STEP_STATUS_CANCELLED

      static final int STEP_STATUS_CANCELLED
      Process cancelled
      See Also:

  • Method Details

    • getProcess

      IBpmProcess getProcess()
      Returns process instance for this step

    • getStepDefinition

      IBpmProcessStepDefinition getStepDefinition() throws Exception
      Returns step definition for this step
      Throws:
      Exception

    • getStepID

      String getStepID() throws Exception
      Returns this stepID
      Throws:
      Exception

    • getStartDate

      Date getStartDate() throws Exception
      Date/time when this step was started
      Throws:
      Exception

    • getEndDate

      Date getEndDate() throws Exception
      Date/time when this step was ended
      Throws:
      Exception

    • getStatus

      int getStatus()
      Returns status of this step

    • setStatus

      void setStatus(int status)
      Sets status of this step
      Parameters:
      status -

    • getName

      String getName()
      Returns step name

    • setName

      void setName(String name)
      Sets step name

    • getTaskID

      String getTaskID()
      Returns taskID for this step

    • setTaskID

      void setTaskID(String taskID)
      Sets taskID for this step
      Parameters:
      taskID -

    • getTaskStatus

      String getTaskStatus()
      Returns task status for this step

    • setTaskStatus

      void setTaskStatus(String taskStatus)
      Sets task status for this step
      Parameters:
      taskStatus -

    • getTaskTypeID

      String getTaskTypeID()
      Returns taskTypeID for this step

    • setTaskTypeID

      void setTaskTypeID(String taskTypeID)
      Sets taskTypeID for this step
      Parameters:
      taskTypeID -

    • getTaskUsers

      List<String> getTaskUsers()
      Returns list of all task users for this step
      Returns:

    • addTaskUser

      void addTaskUser(String taskUser)
      Adds a task user for this step
      Parameters:
      taskUser -

    • removeTaskUser

      void removeTaskUser(String taskUser)
      Removes task user from this step
      Parameters:
      taskUser -

    • getCustomFields

      IBpmProcessCustomFields getCustomFields()
      Returns custom fields for this step

    • getErrors

      List<IBpmProcessError> 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