com.smartgwt.client.util.workflow

Class StateTask

java.lang.Object

com.smartgwt.client.core.BaseClass

com.smartgwt.client.util.workflow.ProcessElement

com.smartgwt.client.util.workflow.Task

com.smartgwt.client.util.workflow.StateTask

All Implemented Interfaces:

com.google.gwt.event.shared.HasHandlers

public class StateTask
extends Task

StateTask can either copy fields of Process.state to other fields, or apply hardcoded values to Process.state via value.

Some examples:

• inputField: "a", outputField: "b" - copies "a" to "b"
• inputField: "a", outputField: "b", type: "integer" - copies "a" to "b" converting "a" to an integer
• inputFieldList: ["a","b"], outputField: ["c","d"] - copies "a" and "b" to "c" and "d" respectively.

Field Summary

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

config, configOnly, factoryCreated, factoryProperties, id, scClassName

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
com.google.gwt.core.client.JavaScriptObject	create()
java.lang.String	getFailureElement() ID of the next sequence or element to proceed to if a failure condition arises, such as the output data not being convertible to the target type.
java.lang.String	getFieldListsLengthMismatchMessage() The default message to be reported with getInvalidTaskMessage() when the inputFieldList and outputFieldList properties do not have the same length.
static StateTask	getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
java.lang.Boolean	getPassThruOutput() Does this processElement pass through output from the last executed task (i.e.
StateTask	setFailureElement(java.lang.String failureElement) ID of the next sequence or element to proceed to if a failure condition arises, such as the output data not being convertible to the target type.
StateTask	setFieldListsLengthMismatchMessage(java.lang.String fieldListsLengthMismatchMessage) The default message to be reported with getInvalidTaskMessage() when the inputFieldList and outputFieldList properties do not have the same length.
StateTask	setPassThruOutput(java.lang.Boolean passThruOutput) Does this processElement pass through output from the last executed task (i.e.

Methods inherited from class com.smartgwt.client.util.workflow.Task

getInputField, getInputFieldList, getOutputExpression, getOutputField, getOutputFieldList, setInputField, setInputFieldList, setOutputExpression, setOutputField, setOutputFieldList

Methods 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, getProcessElements, getSupportsMultipleInputRecords, getTextFormulaValue, getTypeTitle, getUndefinedComponentMessage, getUnresolvedComponentMessage, getWaitDuration, getWaitFor, getWaitLocator, isCreated, isValid, objectReferencesLastTaskOutput, onInit, reset, setAttribute, setBindOutput, setClassDescription, setDescription, setEditorType, setForceSingle, setID, setJavaScriptObject, setMockMode, setNextElement, setSupportsMultipleInputRecords, setTypeTitle, setUndefinedComponentMessage, setUnresolvedComponentMessage, setWaitDuration, setWaitFor, setWaitLocator, updateGlobalIDInCriteria, updateGlobalIDInTextFormula, updateGlobalIDInValueProperty, updateGlobalIDInValues, updateGlobalIDReferences, updateLastElementBindingReferences, updateLastElementInCriteria, updateLastElementInValueProperty, updateLastElementInValues

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, 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

Methods inherited from class java.lang.Object

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

Constructor Detail

StateTask

public StateTask()

StateTask

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

Method Detail

getOrCreateRef

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

create

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

Overrides:

create in class Task

setFailureElement

public StateTask setFailureElement(java.lang.String failureElement)
                            throws java.lang.IllegalStateException

ID of the next sequence or element to proceed to if a failure condition arises, such as the output data not being convertible to the target type.

Parameters:

failureElement - New failureElement value. Default value is null

Returns:

StateTask instance, for chaining setter calls

Throws:

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

getFailureElement

public java.lang.String getFailureElement()

ID of the next sequence or element to proceed to if a failure condition arises, such as the output data not being convertible to the target type.

Returns:

Current failureElement value. Default value is null

setFieldListsLengthMismatchMessage

public StateTask setFieldListsLengthMismatchMessage(java.lang.String fieldListsLengthMismatchMessage)
                                             throws java.lang.IllegalStateException

The default message to be reported with getInvalidTaskMessage() when the inputFieldList and outputFieldList properties do not have the same length.

Parameters:

fieldListsLengthMismatchMessage - New fieldListsLengthMismatchMessage value. Default value is "outputFieldList should have same number of parameters as inputFieldList"

Returns:

StateTask instance, for chaining setter calls

Throws:

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

getFieldListsLengthMismatchMessage

public java.lang.String getFieldListsLengthMismatchMessage()

The default message to be reported with getInvalidTaskMessage() when the inputFieldList and outputFieldList properties do not have the same length.

Returns:

Current fieldListsLengthMismatchMessage value. Default value is "outputFieldList should have same number of parameters as inputFieldList"

setPassThruOutput

public StateTask setPassThruOutput(java.lang.Boolean passThruOutput)
                            throws java.lang.IllegalStateException

Does this processElement pass through output from the last executed task (i.e. transient state)?

See taskInputExpressions for details on the transient state outputs.

Note that this property does not affect the task at all but is an indicator to the user and to the workflow editor of the behavior of the task as coded (See Process.passThruTaskOutput()).

Overrides:

setPassThruOutput in class ProcessElement

Parameters:

passThruOutput - New passThruOutput value. Default value is false

Returns:

StateTask instance, for chaining setter calls

Throws:

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

getPassThruOutput

public java.lang.Boolean getPassThruOutput()

Does this processElement pass through output from the last executed task (i.e. transient state)?

See taskInputExpressions for details on the transient state outputs.

Note that this property does not affect the task at all but is an indicator to the user and to the workflow editor of the behavior of the task as coded (See Process.passThruTaskOutput()).

Overrides:

getPassThruOutput in class ProcessElement

Returns:

Current passThruOutput value. Default value is false