Package com.morpheusdata.model

Class ProcessStepUpdate

java.lang.Object
com.morpheusdata.model.ProcessStepUpdate
public class ProcessStepUpdate extends Object
Update model for a Process Step (AKA ProcessEvent)

  • Field Details

    • status

      public String status
      The status for the step update

      This should not be set to MorpheusProcessService.STATUS_COMPLETE or MorpheusProcessService.STATUS_FAILED during an update, as those are final states that should only be set when ending a process or a process step.

      This can be found in the history detail view of the step.

    • output

      public String output
      The output for the step update

      If the output is set to append with update call (see MorpheusProcessService.updateProcessStep(Process, ProcessStepType, ProcessStepUpdate, Boolean)) this output is appended to the existing. Otherwise, it'll replace it entirely.

      A preview of this can be found in the history list and the full output can be found in the history detail view of the step.

    • message

      public String message
      The message for the step update

      If the message is set to append with update call (see MorpheusProcessService.updateProcessStep(Process, ProcessStepType, ProcessStepUpdate, Boolean)) this message is appended to the existing. Otherwise, it'll replace it entirely.

      This can be found in the history detail view of the step. It has its own line in the detail view and is also prepended to the top of the output text area. This isn't shown if the status is 'failed', in that case the error is displayed instead

    • error

      public String error
      The error for the step update

      If the error is set to append with update call (see MorpheusProcessService.updateProcessStep(Process, ProcessStepType, ProcessStepUpdate, Boolean)) this error is appended to the existing. Otherwise, it'll replace it entirely.

      This can be found in the history detail view of the step. It has its own line in the detail view and is also prepended to the top of the output text area. This only shown if the status is 'failed', in that case the error is displayed in place of the message field.

    • username

      public String username
      An override for username. If unspecified, the username associated with the process is used

    • userId

      public String userId
      An override for userId. If unspecified, the userId associated with the process is used

    • userDisplayName

      public String userDisplayName
      An override for userDisplayName. If unspecified, the userDisplayName associated with the process is used

  • Constructor Details

    • ProcessStepUpdate

      public ProcessStepUpdate()

  • Method Details

    • getStatus

      public String getStatus()

    • setStatus

      public void setStatus(String status)

    • getOutput

      public String getOutput()

    • setOutput

      public void setOutput(String output)

    • getMessage

      public String getMessage()

    • setMessage

      public void setMessage(String message)

    • getError

      public String getError()

    • setError

      public void setError(String error)

    • getUsername

      public String getUsername()

    • setUsername

      public void setUsername(String username)

    • getUserId

      public String getUserId()

    • setUserId

      public void setUserId(String userId)

    • getUserDisplayName

      public String getUserDisplayName()

    • setUserDisplayName

      public void setUserDisplayName(String userDisplayName)