Class BuildViaAIRequest
- All Implemented Interfaces:
HasHandlers
- Direct Known Subclasses:
ApplyAIFilterRequest,BuildAIFieldRequestRequest,BuildCriterionRequest,BuildUIViaAIRequest,ReapplyAIFilterRequest
-
Field Summary
Fields inherited from class com.smartgwt.client.core.RefDataClass
idFields inherited from class com.smartgwt.client.core.DataClass
factoryCreated, factoryProperties -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionThe maximum number of retries of any one particular request to an AI engine.static BuildViaAIRequestgetOrCreateRef(JavaScriptObject jsObj) Whenshowing a progress dialog, theBuildViaAIProgressDialogproperties to apply.Whether to show a progress dialog to inform the user about the processing of the build-request.The user's request to AI in the context of this build-via-AI operation.Whether the user can cancel the build-request.setMaxRetries(Integer maxRetries) The maximum number of retries of any one particular request to an AI engine.setProgressDialogProperties(BuildViaAIProgressDialog progressDialogProperties) Whenshowing a progress dialog, theBuildViaAIProgressDialogproperties to apply.setShowProgressDialog(Boolean showProgressDialog) Whether to show a progress dialog to inform the user about the processing of the build-request.setUserAIRequest(UserAIRequest userAIRequest) The user's request to AI in the context of this build-via-AI operation.setUserCanCancel(Boolean userCanCancel) Whether the user can cancel the build-request.Methods inherited from class com.smartgwt.client.util.AsyncOperationParams
getCancellationController, setCancellationControllerMethods inherited from class com.smartgwt.client.core.RefDataClass
getRef, getRef, internalSetIDMethods 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
-
Constructor Details
-
BuildViaAIRequest
public BuildViaAIRequest() -
BuildViaAIRequest
-
-
Method Details
-
getOrCreateRef
-
setMaxRetries
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 + maxRetriesnumber of times for up to2 * (1 + maxRetries)total requests.- Parameters:
maxRetries- New maxRetries value. Default value is 2- Returns:
BuildViaAIRequestinstance, for chaining setter calls
-
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 + maxRetriesnumber of times for up to2 * (1 + maxRetries)total requests.- Returns:
- Current maxRetries value. Default value is 2
-
setProgressDialogProperties
public BuildViaAIRequest setProgressDialogProperties(BuildViaAIProgressDialog progressDialogProperties) Whenshowing a progress dialog, theBuildViaAIProgressDialogproperties to apply.Note : This is an advanced setting
- Parameters:
progressDialogProperties- New progressDialogProperties value. Default value is null- Returns:
BuildViaAIRequestinstance, for chaining setter calls- See Also:
-
getProgressDialogProperties
Whenshowing a progress dialog, theBuildViaAIProgressDialogproperties to apply.- Returns:
- Current progressDialogProperties value. Default value is null
-
setShowProgressDialog
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:
BuildViaAIRequestinstance, for chaining setter calls
-
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
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:
BuildViaAIRequestinstance, for chaining setter calls
-
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
Whether the user can cancel the build-request. IfshowProgressDialogistrue, then the progress dialog will have a cancel button ifuserCanCancelis set.Other user cancellation mechanisms may be added in the future, but
userCanCancelwill be respected.- Parameters:
userCanCancel- New userCanCancel value. Default value is true- Returns:
BuildViaAIRequestinstance, for chaining setter calls
-
getUserCanCancel
Whether the user can cancel the build-request. IfshowProgressDialogistrue, then the progress dialog will have a cancel button ifuserCanCancelis set.Other user cancellation mechanisms may be added in the future, but
userCanCancelwill be respected.- Returns:
- Current userCanCancel value. Default value is true
-