Package com.smartgwt.client.ai

Class BuildViaAIRequest

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
All Implemented Interfaces:
HasHandlers
Direct Known Subclasses:
ApplyAIFilterRequest, BuildAIFieldRequestRequest, BuildCriterionRequest, BuildUIViaAIRequest, ReapplyAIFilterRequest
public class BuildViaAIRequest extends AsyncOperationParams
Base class for a representation of a high-level request to AI to build something.

  • Constructor Details

    • BuildViaAIRequest

      public BuildViaAIRequest()

    • BuildViaAIRequest

      public BuildViaAIRequest(JavaScriptObject jsObj)

  • Method Details

    • getOrCreateRef

      public static BuildViaAIRequest getOrCreateRef(JavaScriptObject jsObj)

    • setMaxRetries

      public BuildViaAIRequest setMaxRetries(Integer maxRetries)
      The maximum number of retries of any one particular request to an AI engine.

      Note that multiple AI requests may be involved in processing the build request. This limit is the maximum number of retries of any one request. For example, if there are 2 requests made to AI, then each one would be submitted at most 1 + maxRetries number of times for up to 2 * (1 + maxRetries) total requests.

      Parameters:
      maxRetries - New maxRetries value. Default value is 2
      Returns:
      BuildViaAIRequest instance, for chaining setter calls

    • getMaxRetries

      public Integer getMaxRetries()
      The maximum number of retries of any one particular request to an AI engine.

      Note that multiple AI requests may be involved in processing the build request. This limit is the maximum number of retries of any one request. For example, if there are 2 requests made to AI, then each one would be submitted at most 1 + maxRetries number of times for up to 2 * (1 + maxRetries) total requests.

      Returns:
      Current maxRetries value. Default value is 2

    • setProgressDialogProperties

      public BuildViaAIRequest setProgressDialogProperties(BuildViaAIProgressDialog progressDialogProperties)
      When showing a progress dialog, the BuildViaAIProgressDialog properties to apply.

      Note : This is an advanced setting

      Parameters:
      progressDialogProperties - New progressDialogProperties value. Default value is null
      Returns:
      BuildViaAIRequest instance, for chaining setter calls
      See Also:

    • getProgressDialogProperties

      public BuildViaAIProgressDialog getProgressDialogProperties()
      When showing a progress dialog, the BuildViaAIProgressDialog properties to apply.
      Returns:
      Current progressDialogProperties value. Default value is null

    • setShowProgressDialog

      public BuildViaAIRequest setShowProgressDialog(Boolean showProgressDialog)
      Whether to show a progress dialog to inform the user about the processing of the build-request.
      Parameters:
      showProgressDialog - New showProgressDialog value. Default value is true
      Returns:
      BuildViaAIRequest instance, for chaining setter calls

    • getShowProgressDialog

      public Boolean getShowProgressDialog()
      Whether to show a progress dialog to inform the user about the processing of the build-request.
      Returns:
      Current showProgressDialog value. Default value is true

    • setUserAIRequest

      public BuildViaAIRequest setUserAIRequest(UserAIRequest userAIRequest)
      The user's request to AI in the context of this build-via-AI operation.
      Parameters:
      userAIRequest - New userAIRequest value. Default value is null
      Returns:
      BuildViaAIRequest instance, for chaining setter calls

    • getUserAIRequest

      public UserAIRequest getUserAIRequest()
      The user's request to AI in the context of this build-via-AI operation.
      Returns:
      Current userAIRequest value. Default value is null

    • setUserCanCancel

      public BuildViaAIRequest setUserCanCancel(Boolean userCanCancel)
      Whether the user can cancel the build-request. If showProgressDialog is true, then the progress dialog will have a cancel button if userCanCancel is set.

      Other user cancellation mechanisms may be added in the future, but userCanCancel will be respected.

      Parameters:
      userCanCancel - New userCanCancel value. Default value is true
      Returns:
      BuildViaAIRequest instance, for chaining setter calls

    • getUserCanCancel

      public Boolean getUserCanCancel()
      Whether the user can cancel the build-request. If showProgressDialog is true, then the progress dialog will have a cancel button if userCanCancel is set.

      Other user cancellation mechanisms may be added in the future, but userCanCancel will be respected.

      Returns:
      Current userCanCancel value. Default value is true