com.smartgwt.client.ai

## Class BuildAIFieldRequestRequest

- java.lang.Object
- - com.smartgwt.client.core.JsObject
  - - com.smartgwt.client.core.DataClass
    - - com.smartgwt.client.core.RefDataClass
      - - com.smartgwt.client.util.AsyncOperationParams
        - - com.smartgwt.client.ai.BuildViaAIRequest
          - - com.smartgwt.client.ai.BuildAIFieldRequestRequest

- All Implemented Interfaces:
    com.google.gwt.event.shared.HasHandlers

      public class BuildAIFieldRequestRequest
      extends BuildViaAIRequest

  Builds an `AIFieldRequest` from a `UserAIRequest` containing a natural language description of the per-record values to generate for a new AI-generated field.
  See Also:
    `AI.buildAIFieldRequest(com.smartgwt.client.ai.BuildAIFieldRequestRequest, com.smartgwt.client.callbacks.BuildAIFieldRequestResponseCallback)`

- - ### Field Summary

    - ### Fields inherited from class com.smartgwt.client.core.RefDataClass

      `id`

    - ### Fields inherited from class com.smartgwt.client.core.DataClass

      `factoryCreated, factoryProperties`

    - ### Fields inherited from class com.smartgwt.client.core.JsObject

      `jsObj`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `BuildAIFieldRequestRequest()`
    `BuildAIFieldRequestRequest(com.google.gwt.core.client.JavaScriptObject jsObj)`

  - ### Method Summary

    All Methods Static Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `DataBoundComponent` | `getComponent()` If specified, the `DataBoundComponent` that will display the AI-generated field.
    `DataSource` | `getDataSource()` The `DataSource` that the AI-generated field will be considered to augment.
    `static BuildAIFieldRequestRequest` | `getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)`
    `java.lang.Boolean` | `getShowProgressDialog()` Whether to show a progress dialog to inform the user about the processing of the build-request.
    `BuildAIFieldRequestRequest` | `setComponent(DataBoundComponent component)` If specified, the `DataBoundComponent` that will display the AI-generated field.
    `BuildAIFieldRequestRequest` | `setDataSource(DataSource dataSource)` The `DataSource` that the AI-generated field will be considered to augment.
    `BuildAIFieldRequestRequest` | `setShowProgressDialog(java.lang.Boolean showProgressDialog)` Whether to show a progress dialog to inform the user about the processing of the build-request.

    - ### Methods inherited from class com.smartgwt.client.ai.BuildViaAIRequest

      `getMaxRetries, getProgressDialogProperties, getUserAIRequest, getUserCanCancel, setMaxRetries, setProgressDialogProperties, setUserAIRequest, setUserCanCancel`

    - ### Methods inherited from class com.smartgwt.client.util.AsyncOperationParams

      `getCancellationController, setCancellationController`

    - ### Methods inherited from class com.smartgwt.client.core.RefDataClass

      `getRef, getRef, internalSetID`

    - ### Methods inherited from class com.smartgwt.client.core.DataClass

      `applyFactoryProperties, doAddHandler, fireEvent, getAttribute, getAttributeAsBoolean, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDouble, getAttributeAsDoubleArray, getAttributeAsElement, getAttributeAsFloat, getAttributeAsInt, getAttributeAsIntArray, getAttributeAsJavaScriptObject, getAttributeAsLong, getAttributeAsMap, getAttributeAsObject, getAttributeAsRecord, getAttributeAsString, getAttributeAsStringArray, getAttributes, getHandlerCount, isFactoryCreated, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttributeAsJavaObject, setFactoryCreated`

    - ### Methods inherited from class com.smartgwt.client.core.JsObject

      `equals, getJsObj, hashCode, isCreated, setJavaScriptObject, setJsObj`

    - ### Methods inherited from class java.lang.Object

      `clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait`

- - ### Constructor Detail

    - #### BuildAIFieldRequestRequest

          public BuildAIFieldRequestRequest()

    - #### BuildAIFieldRequestRequest

          public BuildAIFieldRequestRequest(com.google.gwt.core.client.JavaScriptObject jsObj)

  - ### Method Detail

    - #### getOrCreateRef

          public static BuildAIFieldRequestRequest getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)

    - #### setComponent

          public BuildAIFieldRequestRequest setComponent(DataBoundComponent component)

      If specified, the `DataBoundComponent` that will display the AI-generated field.

      The component should be bound to the same `dataSource` of the request or a `DataSource` inheriting from it.

      Parameters:
        `component` - New component value. Default value is null
      Returns:
        `BuildAIFieldRequestRequest` instance, for chaining setter calls

    - #### getComponent

          public DataBoundComponent getComponent()

      If specified, the `DataBoundComponent` that will display the AI-generated field.

      The component should be bound to the same `dataSource` of the request or a `DataSource` inheriting from it.

      Returns:
        Current component value. Default value is null

    - #### setDataSource

          public BuildAIFieldRequestRequest setDataSource(DataSource dataSource)

      The `DataSource` that the AI-generated field will be considered to augment.

      If `component` is also specified, then the component should be bound to the same `DataSource` or a `DataSource` inheriting from it.

      Parameters:
        `dataSource` - New dataSource value. Default value is null
      Returns:
        `BuildAIFieldRequestRequest` instance, for chaining setter calls

    - #### getDataSource

          public DataSource getDataSource()

      The `DataSource` that the AI-generated field will be considered to augment.

      If `component` is also specified, then the component should be bound to the same `DataSource` or a `DataSource` inheriting from it.

      Returns:
        Current dataSource value. Default value is null

    - #### setShowProgressDialog

          public BuildAIFieldRequestRequest setShowProgressDialog(java.lang.Boolean showProgressDialog)

      Whether to show a progress dialog to inform the user about the processing of the build-request.

      The default value is `false`.

      Overrides:
        `setShowProgressDialog` in class `BuildViaAIRequest`
      Parameters:
        `showProgressDialog` - New showProgressDialog value. Default value is false
      Returns:
        `BuildAIFieldRequestRequest` instance, for chaining setter calls

    - #### getShowProgressDialog

          public java.lang.Boolean getShowProgressDialog()

      Whether to show a progress dialog to inform the user about the processing of the build-request.

      The default value is `false`.

      Overrides:
        `getShowProgressDialog` in class `BuildViaAIRequest`
      Returns:
        Current showProgressDialog value. Default value is false