com.smartgwt.client.util.workflow

## Class UserConfirmationGateway

- java.lang.Object
- - com.smartgwt.client.core.BaseClass
  - - com.smartgwt.client.util.workflow.ProcessElement
    - - com.smartgwt.client.util.workflow.UserConfirmationGateway

- All Implemented Interfaces:
    com.google.gwt.event.shared.HasHandlers
  Direct Known Subclasses:
    AskForValueTask

      public class UserConfirmationGateway
      extends ProcessElement

  Chooses one or another next process element based on confirmation of a message shown to user.

  If the user clicks OK, the `nextElement` is chosen, otherwise the choice is `failureElement`.

- - ### Field Summary

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

      `config, configOnly, factoryCreated, factoryProperties, id, scClassName`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `UserConfirmationGateway()`
    `UserConfirmationGateway(com.google.gwt.core.client.JavaScriptObject jsObj)`

  - ### Method Summary

    All Methods Static Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `com.google.gwt.core.client.JavaScriptObject` | `create()`
    `java.lang.String` | `getFailureElement()` ID of the next sequence or element to proceed to if the criteria do not match.
    `java.lang.String` | `getMessage()` Message to display to the user for confirmation.
    `java.lang.String` | `getNextElement()` Next `sequence` or `element` to execute if the criteria match the process state.
    `static UserConfirmationGateway` | `getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)`
    `UserSummary` | `getTextFormula()` Formula to be used to calculate the message contents.
    `UserConfirmationGateway` | `setFailureElement(java.lang.String failureElement)` ID of the next sequence or element to proceed to if the criteria do not match.
    `UserConfirmationGateway` | `setMessage(java.lang.String message)` Message to display to the user for confirmation.
    `UserConfirmationGateway` | `setNextElement(java.lang.String nextElement)` Next `sequence` or `element` to execute if the criteria match the process state.
    `UserConfirmationGateway` | `setTextFormula(UserSummary textFormula)` Formula to be used to calculate the message contents.

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

      `convertToJavaScriptArray, getClassDescription, getDescription, getEditorType, getElementDescription, getID, getJsObj, getOrCreateJsObj, getPassThruOutput, getProcessElements, getTitle, isCreated, onInit, setAttribute, setClassDescription, setDescription, setEditorType, setID, setJavaScriptObject, 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

    - #### UserConfirmationGateway

          public UserConfirmationGateway()

    - #### UserConfirmationGateway

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

  - ### Method Detail

    - #### getOrCreateRef

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

    - #### create

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

      Overrides:
        `create` in class `ProcessElement`

    - #### setFailureElement

          public UserConfirmationGateway setFailureElement(java.lang.String failureElement)
                                                    throws java.lang.IllegalStateException

      ID of the next sequence or element to proceed to if the criteria do not match.
      Parameters:
        `failureElement` - New failureElement value. Default value is null
      Returns:
        `UserConfirmationGateway` instance, for chaining setter calls
      Throws:
        `java.lang.IllegalStateException` - this property cannot be changed after the underlying component has been created

    - #### getFailureElement

          public java.lang.String getFailureElement()

      ID of the next sequence or element to proceed to if the criteria do not match.
      Returns:
        Current failureElement value. Default value is null

    - #### setMessage

          public UserConfirmationGateway setMessage(java.lang.String message)
                                             throws java.lang.IllegalStateException

      Message to display to the user for confirmation. To display a dynamic message see `textFormula`.
      Parameters:
        `message` - New message value. Default value is null
      Returns:
        `UserConfirmationGateway` instance, for chaining setter calls
      Throws:
        `java.lang.IllegalStateException` - this property cannot be changed after the underlying component has been created

    - #### getMessage

          public java.lang.String getMessage()

      Message to display to the user for confirmation. To display a dynamic message see `textFormula`.
      Returns:
        Current message value. Default value is null

    - #### setNextElement

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

      Next `sequence` or `element` to execute if the criteria match the process state.

      `nextElement` does not need to be specified if this gateway is part of a `sequence` and has a next element in the sequence.

      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.

      Overrides:
        `setNextElement` in class `ProcessElement`
      Parameters:
        `nextElement` - New nextElement value. Default value is null
      Returns:
        `UserConfirmationGateway` instance, for chaining setter calls
      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 if the criteria match the process state.

      `nextElement` does not need to be specified if this gateway is part of a `sequence` and has a next element in the sequence.

      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.

      Overrides:
        `getNextElement` in class `ProcessElement`
      Returns:
        Current nextElement value. Default value is null

    - #### setTextFormula

          public UserConfirmationGateway setTextFormula(UserSummary textFormula)
                                                 throws java.lang.IllegalStateException

      Formula to be used to calculate the message contents. Use `message` property to assign a static message instead.

      Available fields for use in the formula are the current `rule context`.

      Parameters:
        `textFormula` - New textFormula value. Default value is null
      Returns:
        `UserConfirmationGateway` instance, for chaining setter calls
      Throws:
        `java.lang.IllegalStateException` - this property cannot be changed after the underlying component has been created

    - #### getTextFormula

          public UserSummary getTextFormula()

      Formula to be used to calculate the message contents. Use `message` property to assign a static message instead.

      Available fields for use in the formula are the current `rule context`.

      Returns:
        Current textFormula value. Default value is null