Class RunBackendStepOutput

java.lang.Object
com.kingsrook.qqq.backend.core.model.actions.AbstractActionOutput
com.kingsrook.qqq.backend.core.model.actions.processes.RunBackendStepOutput
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
BackendStepPostRunOutput, StreamedBackendStepOutput
public class RunBackendStepOutput extends AbstractActionOutput implements Serializable
Output data container for the RunBackendStep action
See Also:

  • Constructor Details

    • RunBackendStepOutput

      public RunBackendStepOutput()

  • Method Details

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • seedFromRequest

      public void seedFromRequest(RunBackendStepInput runBackendStepInput)
      e.g., populate the process state (records, values) in this result object.

    • getRecords

      public List<QRecord> getRecords()
      Getter for records

    • setRecords

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

    • withRecords

      public RunBackendStepOutput 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 RunBackendStepOutput withValues(Map<String,Serializable> values)
      Setter for values

    • addValue

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

    • getProcessState

      public ProcessState getProcessState()
      Accessor for processState

    • setException

      public void setException(Exception exception)

    • getException

      public Exception getException()

    • 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

    • getValueBoolean

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

    • getValueBigDecimal

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

    • addRecord

      public void addRecord(QRecord record)
      add a record to the step output, e.g., for going through to the next step.

    • addRecordEntity

      public void addRecordEntity(QRecordEntity recordEntity)
      add a RecordEntity to the step output, e.g., for going through to the next step.

    • getAuditInputList

      public List<AuditInput> getAuditInputList()
      Getter for auditInputList

    • setAuditInputList

      public void setAuditInputList(List<AuditInput> auditInputList)
      Setter for auditInputList

    • withAuditInputList

      public RunBackendStepOutput withAuditInputList(List<AuditInput> auditInputList)
      Fluent setter for auditInputList

    • addAuditSingleInput

      public void addAuditSingleInput(AuditSingleInput auditSingleInput)

    • getOverrideLastStepName

      public String getOverrideLastStepName()
      Getter for overrideLastStepName

    • setOverrideLastStepName

      public void setOverrideLastStepName(String overrideLastStepName)
      Setter for overrideLastStepName

    • withOverrideLastStepName

      public RunBackendStepOutput withOverrideLastStepName(String overrideLastStepName)
      Fluent setter for overrideLastStepName

    • updateStepList

      public void updateStepList(List<String> stepList)

    • getProcessName

      public String getProcessName()
      Getter for processName

    • setProcessName

      public void setProcessName(String processName)
      Setter for processName

    • withProcessName

      public RunBackendStepOutput withProcessName(String processName)
      Fluent setter for processName

    • getProcessMetaDataAdjustment

      public ProcessMetaDataAdjustment getProcessMetaDataAdjustment()
      Getter for ProcessMetaDataAdjustment (pass-through to processState)

    • setProcessMetaDataAdjustment

      public void setProcessMetaDataAdjustment(ProcessMetaDataAdjustment processMetaDataAdjustment)
      Setter for updatedFrontendStepList (pass-through to processState)

    • setProcessPayload

      public void setProcessPayload(QProcessPayload processPayload)
      Update the process state with values from the input processPayload subclass instance.

    • getOneTimeSecrets

      public List<OneTimeSecret> getOneTimeSecrets()
      Secrets for the producing invocation only, excluded from state and serialization. Async jobs cannot deliver these: status polling returns only stored state.

    • addOneTimeSecret

      public RunBackendStepOutput addOneTimeSecret(OneTimeSecret secret)
      Return a secret only in this invocation's synchronous HTTP response. Never put the secret in values or records. Async status cannot recover it.