Package com.smartgwt.client.ai

Class AnswerEngineOperation

java.lang.Object
com.smartgwt.client.core.BaseClass
com.smartgwt.client.ai.AnswerEngineOperation
All Implemented Interfaces:
HasHandlers
public class AnswerEngineOperation extends BaseClass
Represents an Answer Engine operation.
See Also:

  • Constructor Details

    • AnswerEngineOperation

      public AnswerEngineOperation()

    • AnswerEngineOperation

      public AnswerEngineOperation(JavaScriptObject jsObj)

  • Method Details

    • getOrCreateRef

      public static AnswerEngineOperation getOrCreateRef(JavaScriptObject jsObj)

    • setJavaScriptObject

      public void setJavaScriptObject(JavaScriptObject jsObj)
      Overrides:
      setJavaScriptObject in class BaseClass

    • create

      public JavaScriptObject create()
      Specified by:
      create in class BaseClass

    • isCreated

      public boolean isCreated()
      Overrides:
      isCreated in class BaseClass

    • getJsObj

      public JavaScriptObject getJsObj()
      Overrides:
      getJsObj in class BaseClass

    • getOrCreateJsObj

      public JavaScriptObject getOrCreateJsObj()
      Overrides:
      getOrCreateJsObj in class BaseClass

    • setAutoShowResult

      public AnswerEngineOperation setAutoShowResult(Boolean autoShowResult) throws IllegalStateException
      Whether the result should be automatically shown to the user.
      Parameters:
      autoShowResult - New autoShowResult value. Default value is false
      Returns:
      AnswerEngineOperation instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the underlying component has been created

    • getAutoShowResult

      public Boolean getAutoShowResult()
      Whether the result should be automatically shown to the user.
      Returns:
      Current autoShowResult value. Default value is false

    • setCurrentStep

      public AnswerEngineOperation setCurrentStep(DataQuestionStep currentStep) throws IllegalStateException
      The current step that this Answer Engine operation is working on.
      Parameters:
      currentStep - New currentStep value. Default value is null
      Returns:
      AnswerEngineOperation instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the underlying component has been created

    • getCurrentStep

      public DataQuestionStep getCurrentStep()
      The current step that this Answer Engine operation is working on.
      Returns:
      Current currentStep value. Default value is null

    • setDataQuestion

      public AnswerEngineOperation setDataQuestion(DataQuestion dataQuestion) throws IllegalStateException
      The data question that is the subject of this Answer Engine operation. This is required to be non-null.
      Parameters:
      dataQuestion - New dataQuestion value. Default value is null
      Returns:
      AnswerEngineOperation instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the underlying component has been created

    • getDataQuestion

      public DataQuestion getDataQuestion()
      The data question that is the subject of this Answer Engine operation. This is required to be non-null.
      Returns:
      Current dataQuestion value. Default value is null

    • setDataSources

      public AnswerEngineOperation setDataSources(DataSource... dataSources) throws IllegalStateException
      The array of available data sources.
      Parameters:
      dataSources - New dataSources value. Default value is null
      Returns:
      AnswerEngineOperation instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the underlying component has been created

    • getDataSources

      public DataSource[] getDataSources()
      The array of available data sources.
      Returns:
      Current dataSources value. Default value is null

    • getJsonEncoder

      public JSONEncoder getJsonEncoder() throws IllegalStateException
      The JSONEncoder created for use by this operation.

      This component is an AutoChild named "jsonEncoder". For an overview of how to use and configure AutoChildren, see Using AutoChildren.

      Returns:
      Current jsonEncoder value. Default value is null
      Throws:
      IllegalStateException - if the underlying component has not yet been created.

    • setMaxRecordsPerQuery

      public AnswerEngineOperation setMaxRecordsPerQuery(Integer maxRecordsPerQuery) throws IllegalStateException
      The maximum number of records that may be requested per query. Must be a positive integer.
      Parameters:
      maxRecordsPerQuery - New maxRecordsPerQuery value. Default value is 15
      Returns:
      AnswerEngineOperation instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the underlying component has been created

    • getMaxRecordsPerQuery

      public Integer getMaxRecordsPerQuery()
      The maximum number of records that may be requested per query. Must be a positive integer.
      Returns:
      Current maxRecordsPerQuery value. Default value is 15

    • setShowNotify

      public AnswerEngineOperation setShowNotify(Boolean showNotify) throws IllegalStateException
      Whether to show a notify for this Answer Engine operation.

      If autoShowResult is also enabled, the notify will be dismissed when the result is shown.

      Parameters:
      showNotify - New showNotify value. Default value is false
      Returns:
      AnswerEngineOperation instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the underlying component has been created

    • getShowNotify

      public Boolean getShowNotify()
      Whether to show a notify for this Answer Engine operation.

      If autoShowResult is also enabled, the notify will be dismissed when the result is shown.

      Returns:
      Current showNotify value. Default value is false