com.smartgwt.client.util.workflow

Class DecisionGateway

java.lang.Object

com.smartgwt.client.core.BaseClass

com.smartgwt.client.util.workflow.ProcessElement

com.smartgwt.client.util.workflow.DecisionGateway

All Implemented Interfaces:

com.google.gwt.event.shared.HasHandlers

public class DecisionGateway
extends ProcessElement

Chooses a next element in a Process by evaluating a series of criteria against the Process.state and choosing the element associated with the criteria that matched, or a defaultElement if none of the criteria match.

Field Summary

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

config, configOnly, factoryCreated, factoryProperties, id, scClassName

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
com.google.gwt.core.client.JavaScriptObject	create()
java.util.LinkedHashMap	getCriteriaMap() Deprecated. in favor of getDecisionList().
TaskDecision[]	getDecisionList() List of TaskDecisions to be processed to find the first with matching criteria.
java.lang.String	getDefaultElement() Next element to pick if no criteria match.
static DecisionGateway	getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
DecisionGateway	setCriteriaMap(java.util.Map<java.lang.String,Criteria> criteriaMap) Deprecated. In favor of decisionList as of SmartGWT release 12.1
DecisionGateway	setDecisionList(TaskDecision... decisionList) List of TaskDecisions to be processed to find the first with matching criteria.
void	setDefaultElement(ProcessElement defaultElement)
DecisionGateway	setDefaultElement(java.lang.String defaultElement) Next element to pick if no criteria match.

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

convertToJavaScriptArray, getClassDescription, getDescription, getEditorType, getElementDescription, getID, getJsObj, getNextElement, getOrCreateJsObj, getPassThruOutput, getProcessElements, getTitle, isCreated, onInit, setAttribute, setClassDescription, setDescription, setEditorType, setID, setJavaScriptObject, setNextElement, setPassThruOutput, setTitle

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

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

DecisionGateway

public DecisionGateway()

DecisionGateway

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

Method Detail

getOrCreateRef

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

create

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

Overrides:

create in class ProcessElement

setCriteriaMap

public DecisionGateway setCriteriaMap(java.util.Map<java.lang.String,Criteria> criteriaMap)
                               throws java.lang.IllegalStateException

Deprecated. In favor of decisionList as of SmartGWT release 12.1

A Map from ProcessElement.ID to Criteria that will cause this ProcessElement to be chosen as the next element if the criteria matches.

If no criteria is matched the next element is defaultElement or the workflow is finished.

Data values in this criteria prefixed with "$" will be treated as dynamic expressions as detailed in TaskInputExpression. Specifically, this means that for simple criteria, any property value that is a String and is prefixed with "$" will be assumed to be an expression, and for AdvancedCriteria, the same treatment will be applied to Criterion.value.

Note that dynamic expressions starting with "$input" are not applicable for an DecisionGateway but "$inputRecord" can be used for direct reference to Process.state.

This property supports DynamicCriteria - use Criterion.valuePath to refer to values in the Process.ruleScope.

Parameters:

criteriaMap - New criteriaMap value. Default value is null

Returns:

DecisionGateway instance, for chaining setter calls

Throws:

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

setDecisionList

public DecisionGateway setDecisionList(TaskDecision... decisionList)
                                throws java.lang.IllegalStateException

List of TaskDecisions to be processed to find the first with matching criteria. The specified TaskDecision.targetTask is then used to identify the the next element.

If no criteria is matched the next element is defaultElement or the workflow is finished.

When providing a DecisionGateway in XML, the decisionList is expressed as:

      <DecisionGateway ID="continentDecision" description="Which continent?" defaultElement="summary">
          <decisionList>
              <taskDecision targetTask="europeVATTask">
                  <criteria fieldName="order.continent" operator="equals" value="Europe" />
              </taskDecision>
              ...
          </decisionList>
      <DecisionGateway>
  

Parameters:

decisionList - New decisionList value. Default value is null

Returns:

DecisionGateway instance, for chaining setter calls

Throws:

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

getDecisionList

public TaskDecision[] getDecisionList()

List of TaskDecisions to be processed to find the first with matching criteria. The specified TaskDecision.targetTask is then used to identify the the next element.

If no criteria is matched the next element is defaultElement or the workflow is finished.

When providing a DecisionGateway in XML, the decisionList is expressed as:

      <DecisionGateway ID="continentDecision" description="Which continent?" defaultElement="summary">
          <decisionList>
              <taskDecision targetTask="europeVATTask">
                  <criteria fieldName="order.continent" operator="equals" value="Europe" />
              </taskDecision>
              ...
          </decisionList>
      <DecisionGateway>
  

Returns:

Current decisionList value. Default value is null

setDefaultElement

public DecisionGateway setDefaultElement(java.lang.String defaultElement)
                                  throws java.lang.IllegalStateException

Next element to pick if no criteria match. If this gateway is part of a sequence and has a next element in the sequence, the defaultElement is assumed to be the next element and does not need to be specified.

Parameters:

defaultElement - New defaultElement value. Default value is null

Returns:

DecisionGateway instance, for chaining setter calls

Throws:

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

getDefaultElement

public java.lang.String getDefaultElement()

Next element to pick if no criteria match. If this gateway is part of a sequence and has a next element in the sequence, the defaultElement is assumed to be the next element and does not need to be specified.

Returns:

Current defaultElement value. Default value is null

getCriteriaMap

public java.util.LinkedHashMap getCriteriaMap()

Deprecated. in favor of getDecisionList().

A Map from ID to Criteria that will cause this ProcessElement to be chosen as the next element if the criteria matches.

Returns:

LinkedHashMap

setDefaultElement

public void setDefaultElement(ProcessElement defaultElement)
                       throws java.lang.IllegalStateException

Throws:

java.lang.IllegalStateException

See Also:

setDefaultElement(String)