com.smartgwt.client.ai

## Class BuildUIViaAIRequest

- 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.BuildUIViaAIRequest

- All Implemented Interfaces:
    com.google.gwt.event.shared.HasHandlers
  Direct Known Subclasses:
    BuildDataBoundUIViaAIRequest

      public class BuildUIViaAIRequest
      extends BuildViaAIRequest

  Represents a request to AI for UI elements.

- - ### 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
    `BuildUIViaAIRequest()`
    `BuildUIViaAIRequest(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.String[]` | `getAllowedUITypes()` The list of allowed UI types.
    `java.lang.Integer` | `getMaxValidationRetries()` The maximum numnber of re-attempts to have the AI fix a validation error.
    `static BuildUIViaAIRequest` | `getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)`
    `UserAIRequest` | `getUserAIRequest()` The request from the user describing what UI they would like the AI to build.
    `BuildUIViaAIValidationType[]` | `getValidationTypes()` The types of validation to use on AI-generated JS code, in the order in which they should be applied.
    `BuildUIViaAIRequest` | `setAllowedUITypes(java.lang.String... allowedUITypes)` The list of allowed UI types.
    `BuildUIViaAIRequest` | `setCustomValidator(BuildUIViaAICustomValidator customValidator)` The custom validation routine to use.
    `BuildUIViaAIRequest` | `setMaxValidationRetries(java.lang.Integer maxValidationRetries)` The maximum numnber of re-attempts to have the AI fix a validation error.
    `BuildUIViaAIRequest` | `setUserAIRequest(UserAIRequest userAIRequest)` The request from the user describing what UI they would like the AI to build.
    `BuildUIViaAIRequest` | `setValidationTypes(BuildUIViaAIValidationType... validationTypes)` The types of validation to use on AI-generated JS code, in the order in which they should be applied.

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

      `getMaxRetries, getProgressDialogProperties, getShowProgressDialog, getUserCanCancel, setMaxRetries, setProgressDialogProperties, setShowProgressDialog, 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

    - #### BuildUIViaAIRequest

          public BuildUIViaAIRequest()

    - #### BuildUIViaAIRequest

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

  - ### Method Detail

    - #### getOrCreateRef

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

    - #### setAllowedUITypes

          public BuildUIViaAIRequest setAllowedUITypes(java.lang.String... allowedUITypes)

      The list of allowed UI types.

      A "UI type" string is usually not the same as the corresponding Smart GWT component type name.

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

    - #### getAllowedUITypes

          public java.lang.String[] getAllowedUITypes()

      The list of allowed UI types.

      A "UI type" string is usually not the same as the corresponding Smart GWT component type name.

      Returns:
        Current allowedUITypes value. Default value is null

    - #### setCustomValidator

          public BuildUIViaAIRequest setCustomValidator(BuildUIViaAICustomValidator customValidator)

      The custom validation routine to use. If this validator is supplied, but `"custom"` is not included among the `validationTypes`, then it is implicitly assumed that custom validation will be performed last.
      Parameters:
        `customValidator` - New customValidator value. Default value is null
      Returns:
        `BuildUIViaAIRequest` instance, for chaining setter calls

    - #### setMaxValidationRetries

          public BuildUIViaAIRequest setMaxValidationRetries(java.lang.Integer maxValidationRetries)

      The maximum numnber of re-attempts to have the AI fix a validation error.
      Parameters:
        `maxValidationRetries` - New maxValidationRetries value. Default value is 1
      Returns:
        `BuildUIViaAIRequest` instance, for chaining setter calls

    - #### getMaxValidationRetries

          public java.lang.Integer getMaxValidationRetries()

      The maximum numnber of re-attempts to have the AI fix a validation error.
      Returns:
        Current maxValidationRetries value. Default value is 1

    - #### setUserAIRequest

          public BuildUIViaAIRequest setUserAIRequest(UserAIRequest userAIRequest)

      The request from the user describing what UI they would like the AI to build.
      Overrides:
        `setUserAIRequest` in class `BuildViaAIRequest`
      Parameters:
        `userAIRequest` - New userAIRequest value. Default value is null
      Returns:
        `BuildUIViaAIRequest` instance, for chaining setter calls

    - #### getUserAIRequest

          public UserAIRequest getUserAIRequest()

      The request from the user describing what UI they would like the AI to build.
      Overrides:
        `getUserAIRequest` in class `BuildViaAIRequest`
      Returns:
        Current userAIRequest value. Default value is null

    - #### setValidationTypes

          public BuildUIViaAIRequest setValidationTypes(BuildUIViaAIValidationType... validationTypes)

      The types of validation to use on AI-generated JS code, in the order in which they should be applied.
      Parameters:
        `validationTypes` - New validationTypes value. Default value is ["default"]
      Returns:
        `BuildUIViaAIRequest` instance, for chaining setter calls

    - #### getValidationTypes

          public BuildUIViaAIValidationType[] getValidationTypes()

      The types of validation to use on AI-generated JS code, in the order in which they should be applied.
      Returns:
        Current validationTypes value. Default value is ["default"]