public class ProcessElement extends BaseClass
Process,
such as a Task or XORGateway.config, configOnly, factoryCreated, factoryProperties, id, scClassName| Constructor and Description |
|---|
ProcessElement() |
ProcessElement(com.google.gwt.core.client.JavaScriptObject jsObj) |
ProcessElement(java.lang.String ID) |
ProcessElement(java.lang.String ID,
java.lang.String nextElement) |
| Modifier and Type | Method and Description |
|---|---|
static com.google.gwt.core.client.JavaScriptObject |
convertToJavaScriptArray(ProcessElement[] array) |
com.google.gwt.core.client.JavaScriptObject |
create() |
java.lang.String |
getClassDescription()
Optional description of the general nature of the kinds of tasks this this process element performs.
|
java.lang.String |
getDescription()
Optional description for this specific instance of process element.
|
java.lang.String |
getEditorType()
Editor type used to edit instances of this type of process element.
|
java.lang.String |
getElementDescription()
Returns a text description of the element derived from the configuration.
|
java.lang.String |
getID()
Optional ID for this process element, allowing it to be referred to from
Gateways, or as the Process.startElement. |
com.google.gwt.core.client.JavaScriptObject |
getJsObj() |
java.lang.String |
getNextElement()
|
com.google.gwt.core.client.JavaScriptObject |
getOrCreateJsObj() |
static ProcessElement |
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.
|
ProcessElement[] |
getProcessElements(java.lang.String attribute) |
java.lang.String |
getTitle()
Optional short, descriptive title for this process element.
|
boolean |
isCreated() |
protected void |
onInit() |
ProcessElement |
setAttribute(java.lang.String attribute,
ProcessElement[] value,
boolean allowPostCreate) |
ProcessElement |
setClassDescription(java.lang.String classDescription)
Optional description of the general nature of the kinds of tasks this this process element performs.
|
ProcessElement |
setDescription(java.lang.String description)
Optional description for this specific instance of process element.
|
ProcessElement |
setEditorType(java.lang.String editorType)
Editor type used to edit instances of this type of process element.
|
ProcessElement |
setID(java.lang.String ID)
Optional ID for this process element, allowing it to be referred to from
Gateways, or as the Process.startElement. |
void |
setJavaScriptObject(com.google.gwt.core.client.JavaScriptObject jsObj) |
ProcessElement |
setNextElement(java.lang.String nextElement)
|
ProcessElement |
setPassThruOutput(java.lang.Boolean passThruOutput)
Does this processElement pass through output from the last executed task (i.e.
|
ProcessElement |
setTitle(java.lang.String title)
Optional short, descriptive title for this process element.
|
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, setScClassNamepublic ProcessElement()
public ProcessElement(com.google.gwt.core.client.JavaScriptObject jsObj)
public ProcessElement(java.lang.String ID)
public ProcessElement(java.lang.String ID,
java.lang.String nextElement)
public static ProcessElement getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
public void setJavaScriptObject(com.google.gwt.core.client.JavaScriptObject jsObj)
setJavaScriptObject in class BaseClasspublic com.google.gwt.core.client.JavaScriptObject create()
public com.google.gwt.core.client.JavaScriptObject getJsObj()
public com.google.gwt.core.client.JavaScriptObject getOrCreateJsObj()
getOrCreateJsObj in class BaseClasspublic ProcessElement setClassDescription(java.lang.String classDescription) throws java.lang.IllegalStateException
description which describes what the
specific instance of the process element has been configured to do. For example, the classDescription
for a task to disable a field might be "disables a field" whereas the description for a concrete instance
might be "disables the 'shipTo' field in the 'ordering' form".
Used by editor to display additional details along
with title.
classDescription - New classDescription value. Default value is nullProcessElement instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdpublic java.lang.String getClassDescription()
description which describes what the
specific instance of the process element has been configured to do. For example, the classDescription
for a task to disable a field might be "disables a field" whereas the description for a concrete instance
might be "disables the 'shipTo' field in the 'ordering' form".
Used by editor to display additional details along
with title.
public ProcessElement setDescription(java.lang.String description) throws java.lang.IllegalStateException
description - New description value. Default value is nullProcessElement instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdpublic java.lang.String getDescription()
public ProcessElement setEditorType(java.lang.String editorType) throws java.lang.IllegalStateException
editorType - New editorType value. Default value is nullProcessElement instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdpublic java.lang.String getEditorType()
public ProcessElement setID(java.lang.String ID) throws java.lang.IllegalStateException
Gateways, or as the Process.startElement. See ProcessSequence and Process to understand
when this is required or can be omitted. Unlike Canvas.ID a
processElement's is a not a globally unique variable, it need only by unique within it's process.
When
assigned an ID, a processElement can be retrieve via Process.getElement().
setID in class BaseClassID - New ID value. Default value is nullProcessElement instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdpublic java.lang.String getID()
Gateways, or as the Process.startElement. See ProcessSequence and Process to understand
when this is required or can be omitted. Unlike Canvas.ID a
processElement's is a not a globally unique variable, it need only by unique within it's process.
When
assigned an ID, a processElement can be retrieve via Process.getElement().
public ProcessElement setNextElement(java.lang.String nextElement) throws java.lang.IllegalStateException
sequence or element to execute after this one completes.
nextElement does not need to be specified on most elements if you use sequences.
Note that if there is both a
sequence and a normal element with the same name in the current Process, the
sequence will be used.
nextElement - New nextElement value. Default value is nullProcessElement instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdpublic java.lang.String getNextElement()
sequence or element to execute after this one completes.
nextElement does not need to be specified on most elements if you use sequences.
Note that if there is both a
sequence and a normal element with the same name in the current Process, the
sequence will be used.
public ProcessElement setPassThruOutput(java.lang.Boolean passThruOutput) throws java.lang.IllegalStateException
taskInputExpressions for details on the transient state.passThruOutput - New passThruOutput value. Default value is trueProcessElement instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdpublic java.lang.Boolean getPassThruOutput()
taskInputExpressions for details on the transient state.public ProcessElement setTitle(java.lang.String title) throws java.lang.IllegalStateException
title - New title value. Default value is nullProcessElement instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdpublic java.lang.String getTitle()
public java.lang.String getElementDescription()
If no override is provided by the concrete
ProcessElement implementation the description or
ID is returned.
public ProcessElement setAttribute(java.lang.String attribute, ProcessElement[] value, boolean allowPostCreate)
public ProcessElement[] getProcessElements(java.lang.String attribute)
public static com.google.gwt.core.client.JavaScriptObject convertToJavaScriptArray(ProcessElement[] array)