com.smartgwt.client.ai

## Class SuggestRecordSummaryTitleRequest

- 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.util.AsyncDataBoundOperationParams
          - - com.smartgwt.client.ai.DataBoundAIRequest
            - - com.smartgwt.client.ai.SuggestRecordSummaryTitleRequest

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

      public class SuggestRecordSummaryTitleRequest
      extends DataBoundAIRequest

  Represents a request to AI to suggest an appropriate title for a new field that will contain AI-generated record summaries.

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

  - ### Method Summary

    All Methods Static Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `SingleSourceAIRequest` | `getAIRequest()`
    `AIMessageSource` | `getAIRequestSource()` The source of the `aiRequest`.
    `static SuggestRecordSummaryTitleRequest` | `getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)`
    `java.lang.String[]` | `getVisibleFieldNames()` The list of field names that are considered visible.
    `SuggestRecordSummaryTitleRequest` | `setAIRequest(SingleSourceAIRequest aiRequest)`
    `SuggestRecordSummaryTitleRequest` | `setAIRequestSource(AIMessageSource aiRequestSource)` The source of the `aiRequest`.
    `SuggestRecordSummaryTitleRequest` | `setVisibleFieldNames(java.lang.String... visibleFieldNames)` The list of field names that are considered visible.

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

      `getExcludeFieldNames, getMaxRetries, setExcludeFieldNames, setMaxRetries`

    - ### Methods inherited from class com.smartgwt.client.util.AsyncDataBoundOperationParams

      `getComponent, getDataSource, setComponent, setDataSource`

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

    - #### SuggestRecordSummaryTitleRequest

          public SuggestRecordSummaryTitleRequest()

    - #### SuggestRecordSummaryTitleRequest

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

  - ### Method Detail

    - #### getOrCreateRef

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

    - #### setAIRequest

          public SuggestRecordSummaryTitleRequest setAIRequest(SingleSourceAIRequest aiRequest)

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

    - #### getAIRequest

          public SingleSourceAIRequest getAIRequest()

      Returns:
        Current aiRequest value. Default value is null

    - #### setAIRequestSource

          public SuggestRecordSummaryTitleRequest setAIRequestSource(AIMessageSource aiRequestSource)

      The source of the `aiRequest`.
      Parameters:
        `aiRequestSource` - New aiRequestSource value. Default value is null
      Returns:
        `SuggestRecordSummaryTitleRequest` instance, for chaining setter calls

    - #### getAIRequestSource

          public AIMessageSource getAIRequestSource()

      The source of the `aiRequest`.
      Returns:
        Current aiRequestSource value. Default value is null

    - #### setVisibleFieldNames

          public SuggestRecordSummaryTitleRequest setVisibleFieldNames(java.lang.String... visibleFieldNames)

      The list of field names that are considered visible.

      By default:

      - If a `component` is set, then its visible fields will be used.
      - The fields of the `dataSource` which do not have `DataSourceField.canView` explicitly set to `false` and additionally do not have `DataSourceField.hidden` explicitly set to `true` are considered the visible fields.
      Parameters:
        `visibleFieldNames` - New visibleFieldNames value. Default value is null
      Returns:
        `SuggestRecordSummaryTitleRequest` instance, for chaining setter calls
      See Also:
        `FieldName`

    - #### getVisibleFieldNames

          public java.lang.String[] getVisibleFieldNames()

      The list of field names that are considered visible.

      By default:

      - If a `component` is set, then its visible fields will be used.
      - The fields of the `dataSource` which do not have `DataSourceField.canView` explicitly set to `false` and additionally do not have `DataSourceField.hidden` explicitly set to `true` are considered the visible fields.
      Returns:
        Current visibleFieldNames value. Default value is null
      See Also:
        `FieldName`