Class FetchRelatedDataTask
java.lang.Object
com.smartgwt.client.core.BaseClass
com.smartgwt.client.util.workflow.ProcessElement
com.smartgwt.client.util.workflow.ComponentTask
com.smartgwt.client.util.workflow.FetchRelatedDataTask
- All Implemented Interfaces:
HasHandlers
Fetch data related to a record in another component.
-
Field Summary
Fields inherited from class com.smartgwt.client.core.BaseClass
config, configOnly, factoryCreated, factoryProperties, id, scClassName -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptioncreate()The DataSource used withrecordSourceComponentto pull related data.The DataSource used withrecordSourceComponentto pull related data.static FetchRelatedDataTaskgetOrCreateRef(JavaScriptObject jsObj) Component to pull record for locating related data.setDataSource(DataSource dataSource) The DataSource used withrecordSourceComponentto pull related data.setDataSource(String dataSource) The DataSource used withrecordSourceComponentto pull related data.setRecordSourceComponent(String recordSourceComponent) Component to pull record for locating related data.Methods inherited from class com.smartgwt.client.util.workflow.ComponentTask
getComponentBaseClass, getComponentBaseClassAsStringArray, getComponentId, getComponentRequiresDataSource, getTargetBaseClass, getTargetBaseClassAsStringArray, getTargetComponent, getTargetComponent, getUnsupportedComponentMessage, setComponentBaseClass, setComponentBaseClass, setComponentId, setComponentRequiresDataSource, setTargetBaseClass, setTargetBaseClass, setUnsupportedComponentMessageMethods inherited from class com.smartgwt.client.util.workflow.ProcessElement
completeElement, convertToJavaScriptArray, executeElement, getBindOutput, getClassDescription, getComponentReferences, getDescription, getDynamicValue, getEditorType, getElementDescription, getForceSingle, getID, getInvalidTaskMessage, getJsObj, getMockMode, getNextElement, getOrCreateJsObj, getPassThruOutput, getProcessElements, getSupportsMultipleInputRecords, getTextFormulaValue, getTypeTitle, getUndefinedComponentMessage, getUnresolvedComponentMessage, getWaitDuration, getWaitFor, getWaitLocator, isCreated, isValid, objectReferencesLastTaskOutput, onInit, reset, setAttribute, setBindOutput, setClassDescription, setDescription, setEditorType, setForceSingle, setID, setJavaScriptObject, setMockMode, setNextElement, setPassThruOutput, setSupportsMultipleInputRecords, setTypeTitle, setUndefinedComponentMessage, setUnresolvedComponentMessage, setWaitDuration, setWaitFor, setWaitLocator, updateGlobalIDInCriteria, updateGlobalIDInTextFormula, updateGlobalIDInValueProperty, updateGlobalIDInValues, updateGlobalIDReferences, updateLastElementBindingReferences, updateLastElementInCriteria, updateLastElementInValueProperty, updateLastElementInValuesMethods 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, getRef, getRuleScope, getScClassName, getTestInstance, hasAutoAssignedID, hasDynamicProperty, internalSetID, internalSetID, isConfigOnly, isFactoryCreated, onBind, registerID, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setConfig, setConfigOnly, setFactoryCreated, setProperty, setProperty, setProperty, setProperty, setRuleScope, setScClassName
-
Constructor Details
-
FetchRelatedDataTask
public FetchRelatedDataTask() -
FetchRelatedDataTask
-
-
Method Details
-
getOrCreateRef
-
create
- Overrides:
createin classComponentTask
-
setDataSource
The DataSource used withrecordSourceComponentto pull related data. If not specified,recordSourceComponentwill be used to obtain the schema.- Parameters:
dataSource- New dataSource value. Default value is null- Returns:
FetchRelatedDataTaskinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created
-
getDataSource
The DataSource used withrecordSourceComponentto pull related data. If not specified,recordSourceComponentwill be used to obtain the schema.- Returns:
- Current dataSource value. Default value is null
-
setDataSource
The DataSource used withrecordSourceComponentto pull related data. If not specified,recordSourceComponentwill be used to obtain the schema.- Parameters:
dataSource- New dataSource value. Default value is null- Returns:
FetchRelatedDataTaskinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created
-
getDataSourceAsString
The DataSource used withrecordSourceComponentto pull related data. If not specified,recordSourceComponentwill be used to obtain the schema.- Returns:
- Current dataSource value. Default value is null
-
setRecordSourceComponent
public FetchRelatedDataTask setRecordSourceComponent(String recordSourceComponent) throws IllegalStateException Component to pull record for locating related data.- Parameters:
recordSourceComponent- New recordSourceComponent value. Default value is null- Returns:
FetchRelatedDataTaskinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created- See Also:
-
getRecordSourceComponent
Component to pull record for locating related data.- Returns:
- Current recordSourceComponent value. Default value is null
- See Also:
-