Class QRecordApiAdapterToApiInput

java.lang.Object
com.kingsrook.qqq.api.actions.io.QRecordApiAdapterToApiInput
All Implemented Interfaces:
Serializable
public class QRecordApiAdapterToApiInput extends Object implements Serializable
Input wrapper for the methods in QRecordApiAdapter that adapt from QRecords To API objects. Originally, the methods in that class just took records and table/apiName/version - but - when we wanted to start adding optional behaviors (e.g., whether to includeExposedJoins), then this class was introduced.
See Also:

  • Constructor Details

    • QRecordApiAdapterToApiInput

      public QRecordApiAdapterToApiInput()

  • Method Details

    • getInputRecords

      public List<QRecord> getInputRecords()
      Getter for inputRecords
      See Also:

    • setInputRecords

      public void setInputRecords(List<QRecord> inputRecords)
      Setter for inputRecords
      See Also:

    • withInputRecords

      public QRecordApiAdapterToApiInput withInputRecords(List<QRecord> inputRecords)
      Fluent setter for inputRecords
      Parameters:
      inputRecords - list of records to be adapted to api objects
      Returns:
      this

    • getTableName

      public String getTableName()
      Getter for tableName
      See Also:

    • setTableName

      public void setTableName(String tableName)
      Setter for tableName
      See Also:

    • withTableName

      public QRecordApiAdapterToApiInput withTableName(String tableName)
      Fluent setter for tableName
      Parameters:
      tableName - name of the table that input records are from (main table, in the case joined records)
      Returns:
      this

    • getApiName

      public String getApiName()
      Getter for apiName
      See Also:

    • setApiName

      public void setApiName(String apiName)
      Setter for apiName
      See Also:

    • withApiName

      public QRecordApiAdapterToApiInput withApiName(String apiName)
      Fluent setter for apiName
      Parameters:
      apiName - api name of the output records
      Returns:
      this

    • getApiVersion

      public String getApiVersion()
      Getter for apiVersion
      See Also:

    • setApiVersion

      public void setApiVersion(String apiVersion)
      Setter for apiVersion
      See Also:

    • withApiVersion

      public QRecordApiAdapterToApiInput withApiVersion(String apiVersion)
      Fluent setter for apiVersion
      Parameters:
      apiVersion - api version for the output records
      Returns:
      this

    • getIncludeExposedJoins

      public boolean getIncludeExposedJoins()
      Getter for includeExposedJoins
      See Also:

    • setIncludeExposedJoins

      public void setIncludeExposedJoins(boolean includeExposedJoins)
      Setter for includeExposedJoins
      See Also:

    • withIncludeExposedJoins

      public QRecordApiAdapterToApiInput withIncludeExposedJoins(boolean includeExposedJoins)
      Fluent setter for includeExposedJoins
      Parameters:
      includeExposedJoins - boolean to control if exposedJoins should be supported. By default, they are not - but a QQQ middleware implementation may want them, so it can set this flag to true to get them
      Returns:
      this