public class UserTask extends Task
A UserTask takes the following steps:
targetView or inlineView DynamicForm designated as the targetForm or to a ValuesManager designated as the targetVM, via setValues() SubmitItem is pressed in either the targetForm or any form
that is a member of the targetVM. Likewise a CancelItem triggers cancellation. Direct calls to
DynamicForm.cancelEditing() or DynamicForm.completeEditing() achieve the same result.
cancelElement if specified. Otherwise the workflow is
immediately finished. outputField, outputFieldList or inputField, in that order. config, configOnly, factoryCreated, factoryProperties, id, scClassName| Constructor and Description |
|---|
UserTask() |
UserTask(com.google.gwt.core.client.JavaScriptObject jsObj) |
| Modifier and Type | Method and Description |
|---|---|
void |
cancelEditing()
Revert any changes made in a form and finish this userTask execution.
|
void |
completeEditing()
Finish editing and store edited values in
process state. |
com.google.gwt.core.client.JavaScriptObject |
create() |
java.lang.String |
getCancelElement()
Next element to proceed to if the task is cancelled because the
targetForm or targetVM had cancelEditing() called on it. |
Canvas |
getInlineView()
An inline definition of the form.
|
static UserTask |
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.
|
java.lang.String |
getPreviousElement()
|
java.lang.Boolean |
getSaveToServer()
If saveToServer is set then the associated form (
targetForm) will perform the normal DynamicForm.submit()
actions when submitted (typically from a SubmitItem). |
DynamicForm |
getTargetForm()
DynamicForm that should be populated with data and that should provide the data for the task outputs.
|
java.lang.String |
getTargetFormAsString()
DynamicForm that should be populated with data and that should provide the data for the task outputs.
|
Canvas |
getTargetView()
Optional widget that should be shown to allow user input.
|
ValuesManager |
getTargetVM()
Optional ValuesManager which will receive task inputs and provide task outputs.
|
java.lang.Boolean |
getWizard()
If wizard is set then associated form will be hidden after user goes to next or prev step of current workflow.
|
void |
goToPrevious()
Set
previousElement as next element of workflow. |
UserTask |
setCancelElement(java.lang.String cancelElement)
Next element to proceed to if the task is cancelled because the
targetForm or targetVM had cancelEditing() called on it. |
UserTask |
setInlineView(Canvas inlineView)
An inline definition of the form.
|
UserTask |
setPassThruOutput(java.lang.Boolean passThruOutput)
Does this processElement pass through output from the last executed task (i.e.
|
UserTask |
setPreviousElement(java.lang.String previousElement)
|
UserTask |
setSaveToServer(java.lang.Boolean saveToServer)
If saveToServer is set then the associated form (
targetForm) will perform the normal DynamicForm.submit()
actions when submitted (typically from a SubmitItem). |
UserTask |
setTargetForm(DynamicForm targetForm)
DynamicForm that should be populated with data and that should provide the data for the task outputs.
|
UserTask |
setTargetForm(java.lang.String targetForm)
DynamicForm that should be populated with data and that should provide the data for the task outputs.
|
void |
setTargetView(Canvas targetView)
Optional widget that should be shown to allow user input.
|
void |
setTargetView(java.lang.String targetView)
Optional widget that should be shown to allow user input.
|
void |
setTargetVM(java.lang.String targetVM)
Optional ValuesManager which will receive task inputs and provide task outputs.
|
void |
setTargetVM(ValuesManager targetVM)
Optional ValuesManager which will receive task inputs and provide task outputs.
|
UserTask |
setWizard(java.lang.Boolean wizard)
If wizard is set then associated form will be hidden after user goes to next or prev step of current workflow.
|
getInputField, getInputFieldList, getOutputExpression, getOutputField, getOutputFieldList, setInputField, setInputFieldList, setOutputExpression, setOutputField, setOutputFieldListcompleteElement, convertToJavaScriptArray, executeElement, getBindOutput, getClassDescription, getDescription, getDynamicValue, getEditorType, getElementDescription, getForceSingle, getID, getJsObj, getMockMode, getNextElement, getOrCreateJsObj, getProcessElements, getSupportsMultipleInputRecords, getTextFormulaValue, getTypeTitle, isCreated, objectReferencesLastTaskOutput, onInit, reset, setAttribute, setBindOutput, setClassDescription, setDescription, setEditorType, setForceSingle, setID, setJavaScriptObject, setMockMode, setNextElement, setSupportsMultipleInputRecords, setTypeTitle, updateGlobalIDInCriteria, updateGlobalIDInValueProperty, updateGlobalIDInValues, updateGlobalIDReferences, updateLastElementBindingReferences, updateLastElementInCriteria, updateLastElementInValueProperty, updateLastElementInValuesaddDynamicProperty, 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 UserTask()
public UserTask(com.google.gwt.core.client.JavaScriptObject jsObj)
public static UserTask getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
public UserTask setCancelElement(java.lang.String cancelElement) throws java.lang.IllegalStateException
targetForm or targetVM had cancelEditing() called on it. if no value is provided the workflow immediately completes.
cancelElement - New cancelElement value. Default value is nullUserTask instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdpublic java.lang.String getCancelElement()
targetForm or targetVM had cancelEditing() called on it. if no value is provided the workflow immediately completes.
public UserTask setInlineView(Canvas inlineView)
targetView to encode form directly in process xml.inlineView - New inlineView value. Default value is nullUserTask instance, for chaining setter callspublic Canvas getInlineView()
targetView to encode form directly in process xml.public UserTask setPassThruOutput(java.lang.Boolean passThruOutput) throws java.lang.IllegalStateException
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()).
setPassThruOutput in class ProcessElementpassThruOutput - New passThruOutput value. Default value is falseUserTask instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdpublic java.lang.Boolean getPassThruOutput()
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()).
getPassThruOutput in class ProcessElementpublic UserTask setPreviousElement(java.lang.String previousElement) throws java.lang.IllegalStateException
sequence or element that is helpful for wizards. This element will be
executed if goToPrevious() method of userTask will be
invoked. You can get userTask for attached form by using userTask property.previousElement - New previousElement value. Default value is nullUserTask instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdpublic java.lang.String getPreviousElement()
sequence or element that is helpful for wizards. This element will be
executed if goToPrevious() method of userTask will be
invoked. You can get userTask for attached form by using userTask property.public UserTask setSaveToServer(java.lang.Boolean saveToServer) throws java.lang.IllegalStateException
targetForm) will perform the normal DynamicForm.submit()
actions when submitted (typically from a SubmitItem). By default the
form submit action is bypassed.saveToServer - New saveToServer value. Default value is falseUserTask instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdpublic java.lang.Boolean getSaveToServer()
targetForm) will perform the normal DynamicForm.submit()
actions when submitted (typically from a SubmitItem). By default the
form submit action is bypassed.public UserTask setTargetForm(DynamicForm targetForm) throws java.lang.IllegalStateException
targetView is a DynamicForm and would also be the targetForm,
the targetForm attribute can be left unset. Use targetVM to use a ValuesManager instead.
targetForm - New targetForm value. Default value is nullUserTask instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdpublic DynamicForm getTargetForm()
targetView is a DynamicForm and would also be the targetForm,
the targetForm attribute can be left unset. Use targetVM to use a ValuesManager instead.
public UserTask setTargetForm(java.lang.String targetForm) throws java.lang.IllegalStateException
targetView is a DynamicForm and would also be the targetForm,
the targetForm attribute can be left unset. Use targetVM to use a ValuesManager instead.
targetForm - New targetForm value. Default value is nullUserTask instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdpublic java.lang.String getTargetFormAsString()
targetView is a DynamicForm and would also be the targetForm,
the targetForm attribute can be left unset. Use targetVM to use a ValuesManager instead.
public UserTask setWizard(java.lang.Boolean wizard) throws java.lang.IllegalStateException
wizard - New wizard value. Default value is falseUserTask instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdpublic java.lang.Boolean getWizard()
public void cancelEditing()
cancelElement will be proceed as the next element of
current process.public void completeEditing()
process state.public void goToPrevious()
previousElement as next element of workflow.
This method could be used to create wizard-like UI behavior.public void setTargetView(Canvas targetView)
targetForm unless either
targetForm or targetVM is set.
UserTask will automatically handle various scenarios of the targetView being not currently
visible or draw()n, according to the following rules:
pane of a tab in a TabSet, the tab will be selected items for a which is either
collapsed or hidden section, the section will be shown and expanded items for a Window, the Window will be shown targetView - targetView Default value is nullpublic Canvas getTargetView()
targetForm unless either
targetForm or targetVM is set.
UserTask will automatically handle various scenarios of the targetView being not currently
visible or draw()n, according to the following rules:
pane of a tab in a TabSet, the tab will be selected items for a which is either
collapsed or hidden section, the section will be shown and expanded items for a Window, the Window will be shown public void setTargetView(java.lang.String targetView)
targetForm unless either
targetForm or targetVM is set.
UserTask will automatically handle various scenarios of the targetView being not currently
visible or draw()n, according to the following rules:
pane of a tab in a TabSet, the tab will be selected items for a which is either
collapsed or hidden section, the section will be shown and expanded items for a Window, the Window will be shown targetView - targetView Default value is nullpublic void setTargetVM(ValuesManager targetVM)
targetForm instead of you want to use a DynamicForm.targetVM - targetVM Default value is nullpublic ValuesManager getTargetVM()
targetForm instead of you want to use a DynamicForm.public void setTargetVM(java.lang.String targetVM)
targetForm instead of you want to use a DynamicForm.targetVM - targetVM Default value is null