Package com.morpheusdata.core.synchronous

Interface MorpheusSynchronousProcessService

All Superinterfaces:
MorpheusSynchronousDataService<Process,Process>
public interface MorpheusSynchronousProcessService extends MorpheusSynchronousDataService<Process,Process>

  • Method Details

    • startProcess

      Process startProcess(Workload workload, ProcessStepType stepType, User user, String timerCategory)
      Start a new Process for the Workload
      Parameters:
      workload - the Workload to associate the Process to
      stepType - the ProcessStepType to start
      user - the User that starts the process (optional)
      timerCategory - a category to associate with this Process. The category is used to provide estimated durations for a Process based on previous run of processes with this same category.
      Returns:
      Boolean indicating success

    • startProcess

      Process startProcess(Workload workload, ProcessStepType stepType, User user, String timerCategory, String eventTitle)
      Start a new Process for the Workload
      Parameters:
      workload - the Workload to associate the Process to
      stepType - the ProcessStepType to start
      user - the User that starts the process (optional)
      timerCategory - a category to associate with this Process. The category is used to provide estimated durations for a Process based on previous run of processes with this same category.
      eventTitle - an event title to associate with this Process
      Returns:
      Boolean indicating success

    • startProcessStep

      Boolean startProcessStep(Process process, ProcessEvent nextEvent, String processStatus)
      Start a new ProcessEvent associated to the Process. This will end any currently running ProcessEvents associated to the Process
      Parameters:
      process - The Process on which to create a new ProcessEvent to start
      nextEvent - The new ProcessEvent to start
      processStatus - The status (i.e. 'complete', 'failed')
      Returns:
      Boolean indicating success

    • startProcessStepAt

      Boolean startProcessStepAt(Process process, ProcessStepType lastStepType, ProcessEvent nextStep, String processStatus)
      Start a new ProcessEvent associated to the Process while ending a specific previous step. This will end the ProcessEvent with the specified lastStepType and then start a new ProcessEvent.
      Parameters:
      process - The Process on which to create a new ProcessEvent to start
      lastStepType - The type of the last step to end before starting the new event
      nextStep - The new ProcessEvent to start
      processStatus - The status (i.e. 'complete', 'failed')
      Returns:
      Boolean indicating success

    • updateProcessStep

      Boolean updateProcessStep(Process process, ProcessStepType lastStepType, ProcessStepUpdate stepUpdate, Boolean appendOutput)
      Updates the last ProcessEvent of type `lastStepType`
      Parameters:
      process - The process to search for an event of type `lastStepType`
      lastStepType - type of the last event to update
      stepUpdate - update parameters for the event
      appendOutput - true to append to the existing output; false to replace
      Returns:
      Boolean indicating success

    • endProcessStep

      Boolean endProcessStep(Process process, String processStatus, String output)
      Stops the last ProcessEvent associated with the Process

      This will not appendOutput and will instead override it. If you want to preserve the existing output, use endProcessStep(Process, String, String, Boolean) which allows you to specify appendOutput = true.

      Parameters:
      process - The Process from which to fetch the last ProcessEvent to stop
      processStatus - The status (i.e. 'complete', 'failed')
      output - The output to associate with the ProcessEvent
      Returns:
      Boolean indicating success

    • endProcessStep

      Boolean endProcessStep(Process process, String processStatus, String output, Boolean appendOutput)
      Stops the last ProcessEvent associated with the Process
      Parameters:
      process - The Process from which to fetch the last ProcessEvent to stop
      processStatus - The status (i.e. 'complete', 'failed')
      output - The output to associate with the ProcessEvent
      appendOutput - true to append to the existing output; false to replace
      Returns:
      Boolean indicating success

    • endProcessStepAt

      Boolean endProcessStepAt(Process process, ProcessStepType lastStepType, String processStatus, String output, Boolean appendOutput)
      Stops a specific ProcessEvent associated with the Process.
      Parameters:
      process - The Process from which to fetch the last ProcessEvent to stop
      lastStepType - The type of the last step to end
      processStatus - The status (i.e. 'complete', 'failed'). If not specified, 'complete' is used.
      output - The output to associate with the ProcessEvent
      appendOutput - true to append to the existing output; false to replace
      Returns:
      Boolean indicating success

    • endProcess

      Boolean endProcess(Process process, String processStatus, String output)
      End the process with the status specified
      Parameters:
      process - The Process to end
      processStatus - The status (i.e. 'complete', 'failed')
      output - The output to associate with the Process
      Returns:
      Boolean indicating success