Class UpdateInput

java.lang.Object
com.kingsrook.qqq.backend.core.model.actions.AbstractActionInput
com.kingsrook.qqq.backend.core.model.actions.AbstractTableActionInput
com.kingsrook.qqq.backend.core.model.actions.tables.update.UpdateInput
public class UpdateInput extends AbstractTableActionInput
Input data handler for the update action

  • Constructor Details

    • UpdateInput

      public UpdateInput()

    • UpdateInput

      public UpdateInput(String tableName)
      Constructor

  • Method Details

    • withTableName

      public UpdateInput withTableName(String tableName)
      Description copied from class: AbstractTableActionInput
      Fluent setter for tableName
      Overrides:
      withTableName in class AbstractTableActionInput

    • withRecord

      public UpdateInput withRecord(QRecord record)

    • withRecordEntity

      public UpdateInput withRecordEntity(QRecordEntity recordEntity)

    • withRecordEntities

      public UpdateInput withRecordEntities(List<? extends QRecordEntity> recordEntityList)

    • getTransaction

      public QBackendTransaction getTransaction()
      Getter for transaction

    • setTransaction

      public void setTransaction(QBackendTransaction transaction)
      Setter for transaction

    • withTransaction

      public UpdateInput withTransaction(QBackendTransaction transaction)
      Fluent setter for transaction

    • getRecords

      public List<QRecord> getRecords()
      Getter for records

    • setRecords

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

    • getAreAllValuesBeingUpdatedTheSame

      public Boolean getAreAllValuesBeingUpdatedTheSame()
      Getter for areAllValuesBeingUpdatedTheSame

    • setAreAllValuesBeingUpdatedTheSame

      public void setAreAllValuesBeingUpdatedTheSame(Boolean areAllValuesBeingUpdatedTheSame)
      Setter for areAllValuesBeingUpdatedTheSame

    • getOmitRecordChangeEvents

      public boolean getOmitRecordChangeEvents()
      Getter for omitRecordChangeEvents

    • setOmitRecordChangeEvents

      public void setOmitRecordChangeEvents(boolean omitRecordChangeEvents)
      Setter for omitRecordChangeEvents

    • withOmitRecordChangeEvents

      public UpdateInput withOmitRecordChangeEvents(boolean omitRecordChangeEvents)
      Fluent setter for omitRecordChangeEvents

    • getOmitDmlAudit

      public boolean getOmitDmlAudit()
      Getter for omitDmlAudit

    • setOmitDmlAudit

      public void setOmitDmlAudit(boolean omitDmlAudit)
      Setter for omitDmlAudit

    • withOmitDmlAudit

      public UpdateInput withOmitDmlAudit(boolean omitDmlAudit)
      Fluent setter for omitDmlAudit

    • withRecords

      public UpdateInput withRecords(List<QRecord> records)
      Fluent setter for records

    • withAreAllValuesBeingUpdatedTheSame

      public UpdateInput withAreAllValuesBeingUpdatedTheSame(Boolean areAllValuesBeingUpdatedTheSame)
      Fluent setter for areAllValuesBeingUpdatedTheSame

    • getAuditContext

      public String getAuditContext()
      Getter for auditContext

    • setAuditContext

      public void setAuditContext(String auditContext)
      Setter for auditContext

    • withAuditContext

      public UpdateInput withAuditContext(String auditContext)
      Fluent setter for auditContext

    • getInputSource

      public InputSource getInputSource()
      Getter for inputSource
      Overrides:
      getInputSource in class AbstractTableActionInput

    • setInputSource

      public void setInputSource(InputSource inputSource)
      Setter for inputSource
      Overrides:
      setInputSource in class AbstractTableActionInput

    • withInputSource

      public UpdateInput withInputSource(InputSource inputSource)
      Fluent setter for inputSource
      Overrides:
      withInputSource in class AbstractTableActionInput
      Parameters:
      inputSource - Indicator of what the source of the action is. Default values from QQQ are USER or SYSTEM (where it can be the case that an action that originated from a USER leads to SYSTEM actions (e.g., running a process - the RunProcessAction is USER initiated, but if that process then runs a query, by default, it would be SYSTEM initiated).
      Returns:
      this

    • getOmitTriggeringAutomations

      public boolean getOmitTriggeringAutomations()
      Getter for omitTriggeringAutomations

    • setOmitTriggeringAutomations

      public void setOmitTriggeringAutomations(boolean omitTriggeringAutomations)
      Setter for omitTriggeringAutomations

    • withOmitTriggeringAutomations

      public UpdateInput withOmitTriggeringAutomations(boolean omitTriggeringAutomations)
      Fluent setter for omitTriggeringAutomations

    • getOmitModifyDateUpdate

      public boolean getOmitModifyDateUpdate()
      Getter for omitModifyDateUpdate

    • setOmitModifyDateUpdate

      public void setOmitModifyDateUpdate(boolean omitModifyDateUpdate)
      Setter for omitModifyDateUpdate

    • withOmitModifyDateUpdate

      public UpdateInput withOmitModifyDateUpdate(boolean omitModifyDateUpdate)
      Fluent setter for omitModifyDateUpdate

    • getFlags

      public Set<ActionFlag> getFlags()
      Getter for flags

    • setFlags

      public void setFlags(Set<ActionFlag> flags)
      Setter for flags

    • withFlags

      public UpdateInput withFlags(Set<ActionFlag> flags)
      Fluent setter for flags

    • withFlag

      public UpdateInput withFlag(ActionFlag flag)

    • hasFlag

      public boolean hasFlag(ActionFlag flag)

    • getDryRun

      public boolean getDryRun()
      Getter for dryRun - if true, fetch the old records and run the pre-update customizers (with isPreview=true) and all validations (records exist and are accessible, required fields, record security locks, field security locks and permissions if enforced) but do NOT store anything: no backend update, no association changes, audits, record change listeners or post-update customizers. The output records are the would-be records after the update (old values overlaid with the input's values, when the backend can fetch old records), with errors/warnings.

    • setDryRun

      public void setDryRun(boolean dryRun)
      Setter for dryRun - see getDryRun.

    • withDryRun

      public UpdateInput withDryRun(boolean dryRun)
      Fluent setter for dryRun - see getDryRun.

    • getExpectedVersions

      public Map<Serializable,Serializable> getExpectedVersions()
      Getter for expectedVersions

    • setExpectedVersions

      public void setExpectedVersions(Map<Serializable,Serializable> expectedVersions)
      Setter for expectedVersions

    • withExpectedVersions

      public UpdateInput withExpectedVersions(Map<Serializable,Serializable> expectedVersions)
      Fluent setter for expectedVersions