com.smartgwt.client.ai

## Class ApplyAIFilterRequest

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

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

      public class ApplyAIFilterRequest
      extends BuildViaAIRequest

  Represents a request to AI to evaluate an "aiFilter" `AdvancedCriteria` on a list of records.
  See Also:
    `AI.applyAIFilter(com.smartgwt.client.ai.ApplyAIFilterRequest, com.smartgwt.client.callbacks.ApplyAIFilterResponseCallback)`

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

  - ### Method Summary

    All Methods Static Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `AdvancedCriteria` | `getAICriterion()` The "aiFilter" `AdvancedCriteria` to evaluate.
    `static ApplyAIFilterRequest` | `getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)`
    `Record[]` | `getRecords()` The records to evaluate.
    `java.lang.Boolean` | `getShowProgressDialog()` Whether to show a progress dialog to inform the user about the processing of the evaluation.
    `ApplyAIFilterRequest` | `setAICriterion(AdvancedCriteria aiCriterion)` The "aiFilter" `AdvancedCriteria` to evaluate.
    `ApplyAIFilterRequest` | `setRecords(Record... records)` The records to evaluate.
    `ApplyAIFilterRequest` | `setShowProgressDialog(java.lang.Boolean showProgressDialog)` Whether to show a progress dialog to inform the user about the processing of the evaluation.

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

    - #### ApplyAIFilterRequest

          public ApplyAIFilterRequest()

    - #### ApplyAIFilterRequest

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

  - ### Method Detail

    - #### getOrCreateRef

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

    - #### setAICriterion

          public ApplyAIFilterRequest setAICriterion(AdvancedCriteria aiCriterion)

      The "aiFilter" `AdvancedCriteria` to evaluate.
      Parameters:
        `aiCriterion` - New aiCriterion value. Default value is null
      Returns:
        `ApplyAIFilterRequest` instance, for chaining setter calls

    - #### getAICriterion

          public AdvancedCriteria getAICriterion()

      The "aiFilter" `AdvancedCriteria` to evaluate.
      Returns:
        Current aiCriterion value. Default value is null

    - #### setRecords

          public ApplyAIFilterRequest setRecords(Record... records)

      The records to evaluate.
      Parameters:
        `records` - New records value. Default value is null
      Returns:
        `ApplyAIFilterRequest` instance, for chaining setter calls

    - #### getRecords

          public Record[] getRecords()

      The records to evaluate.
      Returns:
        Current records value. Default value is null

    - #### setShowProgressDialog

          public ApplyAIFilterRequest setShowProgressDialog(java.lang.Boolean showProgressDialog)

      Whether to show a progress dialog to inform the user about the processing of the evaluation.

      The default value is `false`.

      Overrides:
        `setShowProgressDialog` in class `BuildViaAIRequest`
      Parameters:
        `showProgressDialog` - New showProgressDialog value. Default value is false
      Returns:
        `ApplyAIFilterRequest` 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 evaluation.

      The default value is `false`.

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