com.smartgwt.client.ai

## Class BuildCriterionRequest

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

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

      public class BuildCriterionRequest
      extends BuildViaAIRequest

  Builds an `AdvancedCriteria` object from a `UserAIRequest` containing a natural language description of a filter.
  See Also:
    `AI.buildCriterion(com.smartgwt.client.ai.BuildCriterionRequest, com.smartgwt.client.callbacks.BuildCriterionResponseCallback)`

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

  - ### Method Summary

    All Methods Static Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `DataSource` | `getDataSource()` The `DataSource` on which the user's natural language description of a filter applies.
    `AIServiceMode` | `getMode()` The AI service mode to use.
    `static BuildCriterionRequest` | `getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)`
    `UserAIRequest` | `getUserAIRequest()` The natural language description of a filter.
    `BuildCriterionRequest` | `setDataSource(DataSource dataSource)` The `DataSource` on which the user's natural language description of a filter applies.
    `BuildCriterionRequest` | `setMode(AIServiceMode mode)` The AI service mode to use.
    `BuildCriterionRequest` | `setUserAIRequest(UserAIRequest userAIRequest)` The natural language description of a filter.

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

    - #### BuildCriterionRequest

          public BuildCriterionRequest()

    - #### BuildCriterionRequest

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

  - ### Method Detail

    - #### getOrCreateRef

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

    - #### setDataSource

          public BuildCriterionRequest setDataSource(DataSource dataSource)

      The `DataSource` on which the user's natural language description of a filter applies.
      Parameters:
        `dataSource` - New dataSource value. Default value is null
      Returns:
        `BuildCriterionRequest` instance, for chaining setter calls

    - #### getDataSource

          public DataSource getDataSource()

      The `DataSource` on which the user's natural language description of a filter applies.
      Returns:
        Current dataSource value. Default value is null

    - #### setMode

          public BuildCriterionRequest setMode(AIServiceMode mode)

      The AI service mode to use.
      Parameters:
        `mode` - New mode value. Default value is "hybrid"
      Returns:
        `BuildCriterionRequest` instance, for chaining setter calls

    - #### getMode

          public AIServiceMode getMode()

      The AI service mode to use.
      Returns:
        Current mode value. Default value is "hybrid"

    - #### setUserAIRequest

          public BuildCriterionRequest setUserAIRequest(UserAIRequest userAIRequest)

      The natural language description of a filter.
      Overrides:
        `setUserAIRequest` in class `BuildViaAIRequest`
      Parameters:
        `userAIRequest` - New userAIRequest value. Default value is null
      Returns:
        `BuildCriterionRequest` instance, for chaining setter calls

    - #### getUserAIRequest

          public UserAIRequest getUserAIRequest()

      The natural language description of a filter.
      Overrides:
        `getUserAIRequest` in class `BuildViaAIRequest`
      Returns:
        Current userAIRequest value. Default value is null