Class RunProcessInput

java.lang.Object
com.kingsrook.qqq.backend.core.model.actions.AbstractActionInput
com.kingsrook.qqq.backend.core.model.actions.processes.RunProcessInput
public class RunProcessInput extends AbstractActionInput
Input data container for the RunProcess action

  • Constructor Details

    • RunProcessInput

      public RunProcessInput()

  • Method Details

    • getActionIdentity

      public String getActionIdentity()
      Overrides:
      getActionIdentity in class AbstractActionInput

    • seedFromProcessState

      public void seedFromProcessState(ProcessState processState)
      e.g., for steps after the first step in a process, seed the data in a run function request from a process state.

    • getProcessMetaData

      public QProcessMetaData getProcessMetaData()

    • getProcessName

      public String getProcessName()
      Getter for processName

    • setProcessName

      public void setProcessName(String processName)
      Setter for processName

    • withProcessName

      public RunProcessInput withProcessName(String processName)
      Setter for processName

    • getRecords

      public List<QRecord> getRecords()
      Getter for records

    • setRecords

      public void setRecords(List<QRecord> records)
      Setter for records

    • withRecords

      public RunProcessInput withRecords(List<QRecord> records)
      Setter for records

    • getValues

      public Map<String,Serializable> getValues()
      Getter for values

    • setValues

      public void setValues(Map<String,Serializable> values)
      Setter for values

    • withValue

      public RunProcessInput withValue(String fieldName, Serializable value)

    • withValues

      public RunProcessInput withValues(Map<String,Serializable> values)
      Setter for values

    • addValue

      public RunProcessInput addValue(String fieldName, Serializable value)
      Setter for values

    • getCallback

      public QProcessCallback getCallback()
      Getter for callback

    • setCallback

      public void setCallback(QProcessCallback callback)
      Setter for callback

    • withCallback

      public RunProcessInput withCallback(QProcessCallback callback)
      Setter for callback

    • getValue

      public Serializable getValue(String fieldName)
      Getter for a single field's value

    • getValueString

      public String getValueString(String fieldName)
      Getter for a single field's value

    • getValueInteger

      public Integer getValueInteger(String fieldName)
      Getter for a single field's value

    • getValueBigDecimal

      public BigDecimal getValueBigDecimal(String fieldName)

    • getValueBoolean

      public Boolean getValueBoolean(String fieldName)

    • getValueLocalTime

      public LocalTime getValueLocalTime(String fieldName)

    • getValueLocalDate

      public LocalDate getValueLocalDate(String fieldName)

    • getValueByteArray

      public byte[] getValueByteArray(String fieldName)

    • getValueInstant

      public Instant getValueInstant(String fieldName)

    • getProcessState

      public ProcessState getProcessState()
      Accessor for processState

    • getFrontendStepBehavior

      public RunProcessInput.FrontendStepBehavior getFrontendStepBehavior()
      Getter for frontendStepBehavior

    • setFrontendStepBehavior

      public void setFrontendStepBehavior(RunProcessInput.FrontendStepBehavior frontendStepBehavior)
      Setter for frontendStepBehavior

    • setStartAfterStep

      public void setStartAfterStep(String startAfterStep)

    • getStartAfterStep

      public String getStartAfterStep()

    • setProcessUUID

      public void setProcessUUID(String processUUID)

    • getProcessUUID

      public String getProcessUUID()

    • setAsyncJobCallback

      public void setAsyncJobCallback(AsyncJobCallback asyncJobCallback)
      Description copied from class: AbstractActionInput
      Setter for asyncJobCallback
      Overrides:
      setAsyncJobCallback in class AbstractActionInput

    • getAsyncJobCallback

      public AsyncJobCallback getAsyncJobCallback()
      Description copied from class: AbstractActionInput
      Getter for asyncJobCallback
      Overrides:
      getAsyncJobCallback in class AbstractActionInput

    • getStartAtStep

      public String getStartAtStep()
      Getter for startAtStep

    • setStartAtStep

      public void setStartAtStep(String startAtStep)
      Setter for startAtStep

    • withStartAtStep

      public RunProcessInput withStartAtStep(String startAtStep)
      Fluent setter for startAtStep

    • withFrontendStepBehavior

      public RunProcessInput withFrontendStepBehavior(RunProcessInput.FrontendStepBehavior frontendStepBehavior)
      Fluent setter for frontendStepBehavior
      Parameters:
      frontendStepBehavior -
      Returns:
      this

    • withStartAfterStep

      public RunProcessInput withStartAfterStep(String startAfterStep)
      Fluent setter for startAfterStep
      Parameters:
      startAfterStep -
      Returns:
      this

    • withProcessUUID

      public RunProcessInput withProcessUUID(String processUUID)
      Fluent setter for processUUID
      Parameters:
      processUUID -
      Returns:
      this

    • withAsyncJobCallback

      public RunProcessInput withAsyncJobCallback(AsyncJobCallback asyncJobCallback)
      Fluent setter for asyncJobCallback
      Parameters:
      asyncJobCallback -
      Returns:
      this

    • getInputSource

      public InputSource getInputSource()
      Source of caller values and automatic record loading. Backend code continues to choose the source for its own actions independently.

    • setInputSource

      public void setInputSource(InputSource inputSource)

    • withInputSource

      public RunProcessInput withInputSource(InputSource inputSource)

    • getBackendStepListener

      public BackendStepListener getBackendStepListener()
      Getter for backendStepListener (see BackendStepListener)

    • setBackendStepListener

      public void setBackendStepListener(BackendStepListener backendStepListener)
      Setter for backendStepListener

    • withBackendStepListener

      public RunProcessInput withBackendStepListener(BackendStepListener backendStepListener)
      Fluent setter for backendStepListener

    • isFieldAccessEnforced

      public boolean isFieldAccessEnforced()
      Boundary decision, independent of nested authorized scopes and caller values.

    • setFieldAccessEnforced

      public void setFieldAccessEnforced(boolean fieldAccessEnforced)
      Set only from the process boundary; never from the process values map.