Class GetTableApiFieldsInput

java.lang.Object
com.kingsrook.qqq.backend.core.model.actions.AbstractActionInput
com.kingsrook.qqq.backend.core.model.actions.AbstractTableActionInput
com.kingsrook.qqq.api.model.actions.GetTableApiFieldsInput
public class GetTableApiFieldsInput extends AbstractTableActionInput

  • Constructor Details

    • GetTableApiFieldsInput

      public GetTableApiFieldsInput()

  • Method Details

    • getVersion

      public String getVersion()
      Getter for version

    • setVersion

      public void setVersion(String version)
      Setter for version

    • withVersion

      public GetTableApiFieldsInput withVersion(String version)
      Fluent setter for version

    • withTableName

      public GetTableApiFieldsInput withTableName(String tableName)
      Fluent setter for tableName
      Overrides:
      withTableName in class AbstractTableActionInput

    • getApiName

      public String getApiName()
      Getter for apiName

    • setApiName

      public void setApiName(String apiName)
      Setter for apiName

    • withApiName

      public GetTableApiFieldsInput withApiName(String apiName)
      Fluent setter for apiName

    • getDoCheckTableApiVersion

      public Boolean getDoCheckTableApiVersion()
      Getter for doCheckTableApiVersion

    • setDoCheckTableApiVersion

      public void setDoCheckTableApiVersion(Boolean doCheckTableApiVersion)
      Setter for doCheckTableApiVersion

    • withDoCheckTableApiVersion

      public GetTableApiFieldsInput withDoCheckTableApiVersion(Boolean doCheckTableApiVersion)
      Fluent setter for doCheckTableApiVersion

    • getIncludeVirtualFields

      public boolean getIncludeVirtualFields()
      Getter for includeVirtualFields

    • setIncludeVirtualFields

      public void setIncludeVirtualFields(boolean includeVirtualFields)
      Setter for includeVirtualFields

    • withIncludeVirtualFields

      public GetTableApiFieldsInput withIncludeVirtualFields(boolean includeVirtualFields)
      Fluent setter for includeVirtualFields: also list the table's virtual fields that have explicit api field meta data for this api (output-only).

    • withInputSource

      public GetTableApiFieldsInput withInputSource(InputSource inputSource)
      Description copied from class: AbstractTableActionInput
      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

    • getForSpecification

      public boolean getForSpecification()
      Getter for forSpecification

    • setForSpecification

      public void setForSpecification(boolean forSpecification)
      Setter for forSpecification

    • withForSpecification

      public GetTableApiFieldsInput withForSpecification(boolean forSpecification)
      Fluent setter for forSpecification: list the fields of the model for the published spec, without removing fields a field security lock denies to the current (often absent) session.