Class DeleteInput

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.delete.DeleteInput
public class DeleteInput extends AbstractTableActionInput
Input for a Delete action.

  • Constructor Details

    • DeleteInput

      public DeleteInput()

    • DeleteInput

      public DeleteInput(String tableName)
      Constructor

  • Method Details

    • withTableName

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

    • getTransaction

      public QBackendTransaction getTransaction()
      Getter for transaction

    • setTransaction

      public void setTransaction(QBackendTransaction transaction)
      Setter for transaction

    • withTransaction

      public DeleteInput withTransaction(QBackendTransaction transaction)
      Fluent setter for transaction

    • getPrimaryKeys

      public List<Serializable> getPrimaryKeys()
      Getter for ids

    • setPrimaryKeys

      public void setPrimaryKeys(List<Serializable> primaryKeys)
      Setter for ids

    • withPrimaryKey

      public DeleteInput withPrimaryKey(Serializable primaryKey)
      Fluently add 1 primary key to the delete input

    • withPrimaryKeys

      public DeleteInput withPrimaryKeys(List<Serializable> primaryKeys)
      Setter for ids

    • getQueryFilter

      public QQueryFilter getQueryFilter()
      Getter for queryFilter

    • setQueryFilter

      public void setQueryFilter(QQueryFilter queryFilter)
      Setter for queryFilter

    • withQueryFilter

      public DeleteInput withQueryFilter(QQueryFilter queryFilter)
      Fluent setter for queryFilter

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

    • getOmitRecordChangeEvents

      public boolean getOmitRecordChangeEvents()
      Getter for omitRecordChangeEvents

    • setOmitRecordChangeEvents

      public void setOmitRecordChangeEvents(boolean omitRecordChangeEvents)
      Setter for omitRecordChangeEvents

    • withOmitRecordChangeEvents

      public DeleteInput 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 DeleteInput withOmitDmlAudit(boolean omitDmlAudit)
      Fluent setter for omitDmlAudit

    • getAuditContext

      public String getAuditContext()
      Getter for auditContext

    • setAuditContext

      public void setAuditContext(String auditContext)
      Setter for auditContext

    • withAuditContext

      public DeleteInput withAuditContext(String auditContext)
      Fluent setter for auditContext

    • getFlags

      public Set<ActionFlag> getFlags()
      Getter for flags

    • setFlags

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

    • withFlags

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

    • withFlag

      public DeleteInput withFlag(ActionFlag flag)

    • hasFlag

      public boolean hasFlag(ActionFlag flag)

    • getDryRun

      public boolean getDryRun()
      Getter for dryRun - if true, resolve the records to delete (a filter is always resolved to primary keys), run the pre-delete customizers (with isPreview=true) and all validations, but do NOT delete anything: no backend delete, no association cascades, audits, record change listeners or post-delete customizers. The output's dryRunPrimaryKeys are the keys that would be deleted (deletedRecordCount stays 0); recordsWithErrors/Warnings are as for a real delete. Note that a dry run does not validate the cascading delete of associated child records.

    • setDryRun

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

    • withDryRun

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