public class FormSaveDataTask extends ComponentTask
DynamicForm.saveData()config, configOnly, factoryCreated, factoryProperties, id, scClassName| Constructor and Description |
|---|
FormSaveDataTask() |
FormSaveDataTask(com.google.gwt.core.client.JavaScriptObject jsObj) |
| Modifier and Type | Method and Description |
|---|---|
com.google.gwt.core.client.JavaScriptObject |
create() |
java.lang.String |
getBoundNotifyMessage()
The default message to be shown when a target form is bound to a DataSource.
|
java.lang.Boolean |
getClearAfterSave()
The form will be
cleared after a successful save unless
this property is set to false. |
java.lang.String |
getFailureElement()
ID of the next sequence or element to proceed to if a failure condition arises from operation.
|
java.lang.String |
getNotifyMessage()
The message to be shown when save completes if
showNotification is set. |
java.lang.String |
getNotifyPosition()
Where to show the message, specified as an edge ("T", "B", "R", "L") similar to
Canvas.snapTo, or "C" for center. |
java.lang.String |
getNotifyType()
NotifyType for
notifyMessage. |
static FormSaveDataTask |
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.
|
DSRequest |
getRequestProperties()
Additional properties to set on the DSRequest that will be issued to perform save.
|
java.lang.Boolean |
getShowNotification()
Should a notification message (defined as notifyMessage) be shown after save completes successfully?
|
java.lang.String |
getUnboundNotifyMessage()
The default message to be shown when a target form is not bound to a DataSource.
|
FormSaveDataTask |
setBoundNotifyMessage(java.lang.String boundNotifyMessage)
The default message to be shown when a target form is bound to a DataSource.
|
FormSaveDataTask |
setClearAfterSave(java.lang.Boolean clearAfterSave)
The form will be
cleared after a successful save unless
this property is set to false. |
FormSaveDataTask |
setFailureElement(java.lang.String failureElement)
ID of the next sequence or element to proceed to if a failure condition arises from operation.
|
FormSaveDataTask |
setNotifyMessage(java.lang.String notifyMessage)
The message to be shown when save completes if
showNotification is set. |
FormSaveDataTask |
setNotifyPosition(java.lang.String notifyPosition)
Where to show the message, specified as an edge ("T", "B", "R", "L") similar to
Canvas.snapTo, or "C" for center. |
FormSaveDataTask |
setNotifyType(java.lang.String notifyType)
NotifyType for
notifyMessage. |
FormSaveDataTask |
setPassThruOutput(java.lang.Boolean passThruOutput)
Does this processElement pass through output from the last executed task (i.e.
|
FormSaveDataTask |
setRequestProperties(DSRequest requestProperties)
Additional properties to set on the DSRequest that will be issued to perform save.
|
FormSaveDataTask |
setShowNotification(java.lang.Boolean showNotification)
Should a notification message (defined as notifyMessage) be shown after save completes successfully?
|
FormSaveDataTask |
setUnboundNotifyMessage(java.lang.String unboundNotifyMessage)
The default message to be shown when a target form is not bound to a DataSource.
|
getComponentBaseClass, getComponentBaseClassAsStringArray, getComponentId, getComponentRequiresDataSource, getTargetComponent, getTargetComponent, setComponentBaseClass, setComponentBaseClass, setComponentId, setComponentRequiresDataSourcecompleteElement, 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 FormSaveDataTask()
public FormSaveDataTask(com.google.gwt.core.client.JavaScriptObject jsObj)
public static FormSaveDataTask getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
public com.google.gwt.core.client.JavaScriptObject create()
create in class ComponentTaskpublic FormSaveDataTask setBoundNotifyMessage(java.lang.String boundNotifyMessage) throws java.lang.IllegalStateException
boundNotifyMessage - New boundNotifyMessage value. Default value is "${dsTitle} saved successfully"FormSaveDataTask instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdpublic java.lang.String getBoundNotifyMessage()
public FormSaveDataTask setClearAfterSave(java.lang.Boolean clearAfterSave) throws java.lang.IllegalStateException
cleared after a successful save unless
this property is set to false.clearAfterSave - New clearAfterSave value. Default value is trueFormSaveDataTask instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdpublic java.lang.Boolean getClearAfterSave()
cleared after a successful save unless
this property is set to false.public FormSaveDataTask setFailureElement(java.lang.String failureElement) throws java.lang.IllegalStateException
failureElement - New failureElement value. Default value is nullFormSaveDataTask instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdpublic java.lang.String getFailureElement()
public FormSaveDataTask setNotifyMessage(java.lang.String notifyMessage) throws java.lang.IllegalStateException
showNotification is set. If no message is
configured a default message is used based on the whether the form is bound to a DataSource or not: boundNotifyMessage or unboundNotifyMessage.notifyMessage - New notifyMessage value. Default value is nullFormSaveDataTask instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdpublic java.lang.String getNotifyMessage()
showNotification is set. If no message is
configured a default message is used based on the whether the form is bound to a DataSource or not: boundNotifyMessage or unboundNotifyMessage.public FormSaveDataTask setNotifyPosition(java.lang.String notifyPosition) throws java.lang.IllegalStateException
Canvas.snapTo, or "C" for center. The message will be shown at the center
of the edge specified (or the very center for "C").notifyPosition - New notifyPosition value. Default value is "T"FormSaveDataTask instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdpublic java.lang.String getNotifyPosition()
Canvas.snapTo, or "C" for center. The message will be shown at the center
of the edge specified (or the very center for "C").public FormSaveDataTask setNotifyType(java.lang.String notifyType) throws java.lang.IllegalStateException
notifyMessage.notifyType - New notifyType value. Default value is "message"FormSaveDataTask instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdNotifyTypepublic java.lang.String getNotifyType()
notifyMessage.NotifyTypepublic FormSaveDataTask 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 falseFormSaveDataTask 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 FormSaveDataTask setRequestProperties(DSRequest requestProperties) throws java.lang.IllegalStateException
Note that
willHandleError will always be set true.
requestProperties - New requestProperties value. Default value is nullFormSaveDataTask instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdpublic DSRequest getRequestProperties()
Note that
willHandleError will always be set true.
public FormSaveDataTask setShowNotification(java.lang.Boolean showNotification) throws java.lang.IllegalStateException
showNotification - New showNotification value. Default value is nullFormSaveDataTask instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdpublic java.lang.Boolean getShowNotification()
public FormSaveDataTask setUnboundNotifyMessage(java.lang.String unboundNotifyMessage) throws java.lang.IllegalStateException
unboundNotifyMessage - New unboundNotifyMessage value. Default value is "Saved successfully"FormSaveDataTask instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdpublic java.lang.String getUnboundNotifyMessage()