com.smartgwt.client.ai

## Class BuildHilitesRequest

- 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
            - - com.smartgwt.client.ai.BuildHilitesRequest

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

      public class BuildHilitesRequest
      extends BuildCriterionRequest

  Represents a request to AI for creation of one or more `Hilite` objects from a natural language description of hilite criteria and styling to apply.
  See Also:
    `AI.buildHilites(com.smartgwt.client.ai.BuildHilitesRequest, com.smartgwt.client.callbacks.BuildHilitesResponseCallback)`

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

  - ### Method Summary

    All Methods Static Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `static BuildHilitesRequest` | `getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)`
    `Record[]` | `getRecords()` The records to apply the hilite(s) to.
    `BuildHilitesRequest` | `setRecords(Record... records)` The records to apply the hilite(s) to.

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

      `getDataSource, getMode, getUserAIRequest, setDataSource, setMode, setUserAIRequest`

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

    - #### BuildHilitesRequest

          public BuildHilitesRequest()

    - #### BuildHilitesRequest

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

  - ### Method Detail

    - #### getOrCreateRef

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

    - #### setRecords

          public BuildHilitesRequest setRecords(Record... records)

      The records to apply the hilite(s) to.
      Parameters:
        `records` - New records value. Default value is null
      Returns:
        `BuildHilitesRequest` instance, for chaining setter calls

    - #### getRecords

          public Record[] getRecords()

      The records to apply the hilite(s) to.
      Returns:
        Current records value. Default value is null