com.smartgwt.client.util.workflow

Class ProcessElement

java.lang.Object

com.smartgwt.client.core.BaseClass

com.smartgwt.client.util.workflow.ProcessElement

All Implemented Interfaces:

com.google.gwt.event.shared.HasHandlers

Direct Known Subclasses:

DecisionGateway, ProcessSequence, Task, XORGateway

public class ProcessElement
extends BaseClass

A ProcessElement is an abstract superclass for elements involved in a Process, such as a Task or XORGateway.

Field Summary

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

config, configOnly, factoryCreated, factoryProperties, id, scClassName

Constructor Summary

Constructors

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)

Method Summary

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	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() Next sequence or element to execute after this one completes.
com.google.gwt.core.client.JavaScriptObject	getOrCreateJsObj()
static ProcessElement	getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
ProcessElement[]	getProcessElements(java.lang.String attribute)
boolean	isCreated()
protected void	onInit()
void	setAttribute(java.lang.String attribute, ProcessElement[] value, boolean allowPostCreate)
void	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)
void	setNextElement(java.lang.String nextElement) Next sequence or element to execute after this one completes.

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

applyFactoryProperties, asSGWTComponent, createJsObj, destroy, doAddHandler, doInit, error, error, errorIfNotCreated, fireEvent, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDouble, getAttributeAsElement, getAttributeAsFloat, getAttributeAsInt, getAttributeAsJavaScriptObject, getAttributeAsMap, getAttributeAsString, getAttributeAsStringArray, getClassName, getConfig, getHandlerCount, getRef, getScClassName, getTestInstance, hasAutoAssignedID, 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, setScClassName

Methods inherited from class java.lang.Object

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

Constructor Detail

ProcessElement

public ProcessElement()

ProcessElement

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

ProcessElement

public ProcessElement(java.lang.String ID)

ProcessElement

public ProcessElement(java.lang.String ID,
                      java.lang.String nextElement)

Method Detail

getOrCreateRef

public static ProcessElement 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

setID

public void setID(java.lang.String ID)
           throws java.lang.IllegalStateException

Optional ID for this process element, allowing it to be referred to from 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().

Overrides:

setID in class BaseClass

Parameters:

ID - New ID value. Default value is null

Throws:

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

getID

public java.lang.String getID()

Optional ID for this process element, allowing it to be referred to from 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().

Overrides:

getID in class BaseClass

Returns:

Current ID value. Default value is null

setNextElement

public void setNextElement(java.lang.String nextElement)
                    throws java.lang.IllegalStateException

Next 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.

Parameters:

nextElement - New nextElement value. Default value is null

Throws:

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

getNextElement

public java.lang.String getNextElement()

Next 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.

Returns:

Current nextElement value. Default value is null

onInit

protected void onInit()

Overrides:

onInit in class BaseClass

setAttribute

public void setAttribute(java.lang.String attribute,
                         ProcessElement[] value,
                         boolean allowPostCreate)

getProcessElements

public ProcessElement[] getProcessElements(java.lang.String attribute)

convertToJavaScriptArray

public static com.google.gwt.core.client.JavaScriptObject convertToJavaScriptArray(ProcessElement[] array)