com.smartgwt.client.ai

Class AnswerEngineOperation

java.lang.Object

com.smartgwt.client.core.BaseClass

com.smartgwt.client.ai.AnswerEngineOperation

All Implemented Interfaces:

com.google.gwt.event.shared.HasHandlers

public class AnswerEngineOperation
extends BaseClass

Represents an Answer Engine operation.

See Also:

AnswerEngine overview and related methods

Field Summary

Fields inherited from class com.smartgwt.client.core.BaseClass

config, configOnly, factoryCreated, factoryProperties, id, scClassName

Constructor Summary

Constructors

Constructor and Description
AnswerEngineOperation()
AnswerEngineOperation(com.google.gwt.core.client.JavaScriptObject jsObj)

Method Summary

Modifier and Type	Method and Description
com.google.gwt.core.client.JavaScriptObject	create()
java.lang.Boolean	getAutoShowResult() Whether the result should be automatically shown to the user.
DataQuestion	getDataQuestion() The data question that is the subject of this Answer Engine operation.
DataSource[]	getDataSources() The array of available data sources.
com.google.gwt.core.client.JavaScriptObject	getJsObj()
java.lang.Integer	getMaxRecordsPerQuery() The maximum number of records that may be requested per query.
com.google.gwt.core.client.JavaScriptObject	getOrCreateJsObj()
static AnswerEngineOperation	getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
java.lang.Boolean	getShowNotify() Whether to show a notify for this Answer Engine operation.
boolean	isCreated()
AnswerEngineOperation	setAutoShowResult(java.lang.Boolean autoShowResult) Whether the result should be automatically shown to the user.
AnswerEngineOperation	setDataQuestion(DataQuestion dataQuestion) The data question that is the subject of this Answer Engine operation.
AnswerEngineOperation	setDataSources(DataSource... dataSources) The array of available data sources.
void	setJavaScriptObject(com.google.gwt.core.client.JavaScriptObject jsObj)
AnswerEngineOperation	setMaxRecordsPerQuery(java.lang.Integer maxRecordsPerQuery) The maximum number of records that may be requested per query.
AnswerEngineOperation	setShowNotify(java.lang.Boolean showNotify) Whether to show a notify for this Answer Engine operation.

Methods inherited from class com.smartgwt.client.core.BaseClass

addDynamicProperty, addDynamicProperty, addDynamicProperty, addDynamicProperty, applyFactoryProperties, asSGWTComponent, clearDynamicProperty, createJsObj, destroy, doAddHandler, doInit, error, error, errorIfNotCreated, fireEvent, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDouble, getAttributeAsElement, getAttributeAsFloat, getAttributeAsInt, getAttributeAsJavaScriptObject, getAttributeAsMap, getAttributeAsString, getAttributeAsStringArray, getClassName, getConfig, getHandlerCount, getID, getRef, getRuleScope, getScClassName, getTestInstance, hasAutoAssignedID, hasDynamicProperty, internalSetID, internalSetID, isConfigOnly, isFactoryCreated, onBind, onInit, registerID, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setConfig, setConfigOnly, setFactoryCreated, setID, setProperty, setProperty, setProperty, setProperty, setRuleScope, setScClassName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AnswerEngineOperation

public AnswerEngineOperation()

AnswerEngineOperation

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

Method Detail

getOrCreateRef

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

setJavaScriptObject

public void setJavaScriptObject(com.google.gwt.core.client.JavaScriptObject jsObj)

Overrides:

setJavaScriptObject in class BaseClass

create

public com.google.gwt.core.client.JavaScriptObject create()

Specified by:

create in class BaseClass

isCreated

public boolean isCreated()

Overrides:

isCreated in class BaseClass

getJsObj

public com.google.gwt.core.client.JavaScriptObject getJsObj()

Overrides:

getJsObj in class BaseClass

getOrCreateJsObj

public com.google.gwt.core.client.JavaScriptObject getOrCreateJsObj()

Overrides:

getOrCreateJsObj in class BaseClass

setAutoShowResult

public AnswerEngineOperation setAutoShowResult(java.lang.Boolean autoShowResult)
                                        throws java.lang.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:

java.lang.IllegalStateException - this property cannot be changed after the underlying component has been created

getAutoShowResult

public java.lang.Boolean getAutoShowResult()

Whether the result should be automatically shown to the user.

Returns:

Current autoShowResult value. Default value is false

setDataQuestion

public AnswerEngineOperation setDataQuestion(DataQuestion dataQuestion)
                                      throws java.lang.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:

java.lang.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 java.lang.IllegalStateException

The array of available data sources.

Parameters:

dataSources - New dataSources value. Default value is null

Returns:

AnswerEngineOperation instance, for chaining setter calls

Throws:

java.lang.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

setMaxRecordsPerQuery

public AnswerEngineOperation setMaxRecordsPerQuery(java.lang.Integer maxRecordsPerQuery)
                                            throws java.lang.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:

java.lang.IllegalStateException - this property cannot be changed after the underlying component has been created

getMaxRecordsPerQuery

public java.lang.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(java.lang.Boolean showNotify)
                                    throws java.lang.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:

java.lang.IllegalStateException - this property cannot be changed after the underlying component has been created

getShowNotify

public java.lang.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