Class RunBackendStepInput

java.lang.Object
com.kingsrook.qqq.backend.core.model.actions.AbstractActionInput
com.kingsrook.qqq.backend.core.model.actions.processes.RunBackendStepInput
Direct Known Subclasses:
BackendStepPostRunInput, StreamedBackendStepInput
public class RunBackendStepInput extends AbstractActionInput
Input data container for the RunBackendStep action

  • Constructor Details

    • RunBackendStepInput

      public RunBackendStepInput()

    • RunBackendStepInput

      public RunBackendStepInput(ProcessState processState)

  • Method Details

    • cloneFieldsInto

      public void cloneFieldsInto(RunBackendStepInput target)
      Kinda like a reverse copy-constructor -- for a subclass that wants all the field values from this object. Keep this in sync with the fields in this class! Of note - the processState does NOT get cloned - because... well, in our first use-case (a subclass that doesn't WANT the same/full state), that's what we needed.

    • getStepMetaData

      public QStepMetaData getStepMetaData()

    • getProcessName

      public String getProcessName()
      Getter for processName

    • setProcessName

      public void setProcessName(String processName)
      Setter for processName

    • withProcessName

      public RunBackendStepInput withProcessName(String processName)
      Setter for processName

    • getTableName

      public String getTableName()
      Getter for tableName

    • setTableName

      public void setTableName(String tableName)
      Setter for tableName

    • withTableName

      public RunBackendStepInput withTableName(String tableName)
      Fluent setter for tableName

    • getTable

      public QTableMetaData getTable()

    • getStepName

      public String getStepName()
      Getter for functionName

    • setStepName

      public void setStepName(String stepName)
      Setter for functionName

    • withFunctionName

      public RunBackendStepInput withFunctionName(String functionName)
      Setter for functionName

    • getRecords

      public List<QRecord> getRecords()
      Getter for records

    • getRecordsAsEntities

      public <E extends QRecordEntity> List<E> getRecordsAsEntities(Class<E> entityClass) throws QException
      Getter for records converted to entities of a given type.
      Throws:
      QException

    • setRecords

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

    • withRecords

      public RunBackendStepInput 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

    • withValues

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

    • addValue

      public RunBackendStepInput 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 RunBackendStepInput withCallback(QProcessCallback callback)
      Setter for callback

    • getValue

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

    • getValueLocalDate

      public LocalDate getValueLocalDate(String fieldName)
      Getter for a single field's date value

    • getValueString

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

    • getValueBoolean

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

    • getValuePrimitiveBoolean

      public boolean getValuePrimitiveBoolean(String fieldName)
      Getter for a single field's value as a primitive boolean - with null => false.

    • getValueInteger

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

    • getValueInstant

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

    • getIsStepBack

      public boolean getIsStepBack()
      Accessor for processState's isStepBack attribute

    • getProcessState

      protected ProcessState getProcessState()
      Accessor for processState - protected, because we generally want to access its members through wrapper methods, we think

    • 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

    • getFrontendStepBehavior

      public RunProcessInput.FrontendStepBehavior getFrontendStepBehavior()
      Getter for frontendStepBehavior

    • setFrontendStepBehavior

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

    • withFrontendStepBehavior

      public RunBackendStepInput withFrontendStepBehavior(RunProcessInput.FrontendStepBehavior frontendStepBehavior)
      Fluent setter for frontendStepBehavior

    • getBasepullLastRunTime

      public Instant getBasepullLastRunTime()
      Getter for basepullLastRunTime

    • setBasepullLastRunTime

      public void setBasepullLastRunTime(Instant basepullLastRunTime)
      Setter for basepullLastRunTime

    • withBasepullLastRunTime

      public RunBackendStepInput withBasepullLastRunTime(Instant basepullLastRunTime)
      Fluent setter for basepullLastRunTime

    • setProcessTracer

      public void setProcessTracer(ProcessTracerInterface processTracer)
      Setter for processTracer

    • withProcessTracer

      public RunBackendStepInput withProcessTracer(ProcessTracerInterface processTracer)
      Fluent setter for processTracer

    • getProcessTracer

      public Optional<ProcessTracerInterface> getProcessTracer()

    • traceMessage

      public void traceMessage(ProcessTracerMessage message)

    • getProcess

      public QProcessMetaData getProcess()

    • getProcessPayload

      public <T extends QProcessPayload> T getProcessPayload(Class<T> payloadClass) throws QException
      return a QProcessPayload subclass instance, with values populated from the current process state.
      Throws:
      QException

    • 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 RunBackendStepInput withInputSource(InputSource inputSource)

    • 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.