com.smartgwt.client.ai

## Class BuildViaAIRequest

- 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

- All Implemented Interfaces:
    com.google.gwt.event.shared.HasHandlers
  Direct Known Subclasses:
    ApplyAIFilterRequest, BuildAIFieldRequestRequest, BuildCriterionRequest, BuildUIViaAIRequest, ReapplyAIFilterRequest

      public class BuildViaAIRequest
      extends AsyncOperationParams

  Base class for a representation of a high-level request to AI to build something.

- - ### 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
    `BuildViaAIRequest()`
    `BuildViaAIRequest(com.google.gwt.core.client.JavaScriptObject jsObj)`

  - ### Method Summary

    All Methods Static Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `java.lang.Integer` | `getMaxRetries()` The maximum number of retries of any one particular request to an AI engine.
    `static BuildViaAIRequest` | `getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)`
    `BuildViaAIProgressDialog` | `getProgressDialogProperties()` When `showing a progress dialog`, the `BuildViaAIProgressDialog` properties to apply.
    `java.lang.Boolean` | `getShowProgressDialog()` Whether to show a progress dialog to inform the user about the processing of the build-request.
    `UserAIRequest` | `getUserAIRequest()` The user's request to AI in the context of this build-via-AI operation.
    `java.lang.Boolean` | `getUserCanCancel()` Whether the user can cancel the build-request.
    `BuildViaAIRequest` | `setMaxRetries(java.lang.Integer maxRetries)` The maximum number of retries of any one particular request to an AI engine.
    `BuildViaAIRequest` | `setProgressDialogProperties(BuildViaAIProgressDialog progressDialogProperties)` When `showing a progress dialog`, the `BuildViaAIProgressDialog` properties to apply.
    `BuildViaAIRequest` | `setShowProgressDialog(java.lang.Boolean showProgressDialog)` Whether to show a progress dialog to inform the user about the processing of the build-request.
    `BuildViaAIRequest` | `setUserAIRequest(UserAIRequest userAIRequest)` The user's request to AI in the context of this build-via-AI operation.
    `BuildViaAIRequest` | `setUserCanCancel(java.lang.Boolean userCanCancel)` Whether the user can cancel the build-request.

    - ### 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

    - #### BuildViaAIRequest

          public BuildViaAIRequest()

    - #### BuildViaAIRequest

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

  - ### Method Detail

    - #### getOrCreateRef

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

    - #### setMaxRetries

          public BuildViaAIRequest setMaxRetries(java.lang.Integer maxRetries)

      The maximum number of retries of any one particular request to an AI engine.

      Note that multiple AI requests may be involved in processing the build request. This limit is the maximum number of retries of any one request. For example, if there are 2 requests made to AI, then each one would be submitted at most `1 + maxRetries` number of times for up to `2 * (1 + maxRetries)` total requests.

      Parameters:
        `maxRetries` - New maxRetries value. Default value is 2
      Returns:
        `BuildViaAIRequest` instance, for chaining setter calls

    - #### getMaxRetries

          public java.lang.Integer getMaxRetries()

      The maximum number of retries of any one particular request to an AI engine.

      Note that multiple AI requests may be involved in processing the build request. This limit is the maximum number of retries of any one request. For example, if there are 2 requests made to AI, then each one would be submitted at most `1 + maxRetries` number of times for up to `2 * (1 + maxRetries)` total requests.

      Returns:
        Current maxRetries value. Default value is 2

    - #### setProgressDialogProperties

          public BuildViaAIRequest setProgressDialogProperties(BuildViaAIProgressDialog progressDialogProperties)

      When `showing a progress dialog`, the `BuildViaAIProgressDialog` properties to apply.

      Note : This is an advanced setting

      Parameters:
        `progressDialogProperties` - New progressDialogProperties value. Default value is null
      Returns:
        `BuildViaAIRequest` instance, for chaining setter calls
      See Also:
        `SGWTProperties`

    - #### getProgressDialogProperties

          public BuildViaAIProgressDialog getProgressDialogProperties()

      When `showing a progress dialog`, the `BuildViaAIProgressDialog` properties to apply.
      Returns:
        Current progressDialogProperties value. Default value is null

    - #### setShowProgressDialog

          public BuildViaAIRequest setShowProgressDialog(java.lang.Boolean showProgressDialog)

      Whether to show a progress dialog to inform the user about the processing of the build-request.
      Parameters:
        `showProgressDialog` - New showProgressDialog value. Default value is true
      Returns:
        `BuildViaAIRequest` 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.
      Returns:
        Current showProgressDialog value. Default value is true

    - #### setUserAIRequest

          public BuildViaAIRequest setUserAIRequest(UserAIRequest userAIRequest)

      The user's request to AI in the context of this build-via-AI operation.
      Parameters:
        `userAIRequest` - New userAIRequest value. Default value is null
      Returns:
        `BuildViaAIRequest` instance, for chaining setter calls

    - #### getUserAIRequest

          public UserAIRequest getUserAIRequest()

      The user's request to AI in the context of this build-via-AI operation.
      Returns:
        Current userAIRequest value. Default value is null

    - #### setUserCanCancel

          public BuildViaAIRequest setUserCanCancel(java.lang.Boolean userCanCancel)

      Whether the user can cancel the build-request. If `showProgressDialog` is `true`, then the progress dialog will have a cancel button if `userCanCancel` is set.

      Other user cancellation mechanisms may be added in the future, but `userCanCancel` will be respected.

      Parameters:
        `userCanCancel` - New userCanCancel value. Default value is true
      Returns:
        `BuildViaAIRequest` instance, for chaining setter calls

    - #### getUserCanCancel

          public java.lang.Boolean getUserCanCancel()

      Whether the user can cancel the build-request. If `showProgressDialog` is `true`, then the progress dialog will have a cancel button if `userCanCancel` is set.

      Other user cancellation mechanisms may be added in the future, but `userCanCancel` will be respected.

      Returns:
        Current userCanCancel value. Default value is true