Skip navigation links
com.smartgwt.client.util.workflow

Class Process

    • Constructor Detail

      • Process

        public Process()
      • Process

        public Process(com.google.gwt.core.client.JavaScriptObject jsObj)
    • Method Detail

      • getOrCreateRef

        public static Process getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
      • create

        public com.google.gwt.core.client.JavaScriptObject create()
        Overrides:
        create in class Task
      • setContainerId

        public void setContainerId(java.lang.String containerId)
        Identifier of canvas where UI elements created by using inline view property should be added using addMember.
        Parameters:
        containerId - New containerId value. Default value is null
        See Also:
        GlobalId
      • getContainerId

        public java.lang.String getContainerId()
        Identifier of canvas where UI elements created by using inline view property should be added using addMember.
        Returns:
        Current containerId value. Default value is null
        See Also:
        GlobalId
      • setElements

        public void setElements(ProcessElement... elements)
                         throws java.lang.IllegalStateException
        Elements involved in this Process. You can also group elements into sequences to reduce the need to explicitly define IDs for elements and interlink them.
        Parameters:
        elements - New elements value. Default value is null
        Throws:
        java.lang.IllegalStateException - this property cannot be changed after the underlying component has been created
      • setRuleScope

        public void setRuleScope(java.lang.String ruleScope)
                          throws java.lang.IllegalStateException
        Canvas.ID of the component that manages "rule context" for which this process participates. The rule context can be used in taskInputExpression.
        Overrides:
        setRuleScope in class BaseClass
        Parameters:
        ruleScope - New ruleScope value. Default value is null
        Throws:
        java.lang.IllegalStateException - this property cannot be changed after the underlying component has been created
        See Also:
        Canvas.setRuleScope(java.lang.String)
      • setSequences

        public void setSequences(ProcessSequence... sequences)
                          throws java.lang.IllegalStateException
        Sequences of ProcessElements. By defining a sequences of elements you can make the ProcessElement.nextElement implicit.

        Example of using sequences:

          Process process = new Process();
          process.setStartElement("firstSequence");
          ProcessSequence innerSequence = new ProcessSequence(incTask, add2Task, incTask);
          process.setSequences(
              new ProcessSequence("firstSequence", serviceTask, decisionGateway),
              new ProcessSequence("errorFlow", failureTask, userNotifyTask)
          );
          // standalone process elements not part of sequences
          process.setElements(new ServiceTask(){...});
          Record state = new Record();
          state.setAttribute("someField", "someValue");
          process.setState(state);
          process.start();
          
        Parameters:
        sequences - New sequences value. Default value is null
        Throws:
        java.lang.IllegalStateException - this property cannot be changed after the underlying component has been created
      • getSequences

        public ProcessSequence[] getSequences()
        Sequences of ProcessElements. By defining a sequences of elements you can make the ProcessElement.nextElement implicit.

        Example of using sequences:

          Process process = new Process();
          process.setStartElement("firstSequence");
          ProcessSequence innerSequence = new ProcessSequence(incTask, add2Task, incTask);
          process.setSequences(
              new ProcessSequence("firstSequence", serviceTask, decisionGateway),
              new ProcessSequence("errorFlow", failureTask, userNotifyTask)
          );
          // standalone process elements not part of sequences
          process.setElements(new ServiceTask(){...});
          Record state = new Record();
          state.setAttribute("someField", "someValue");
          process.setState(state);
          process.start();
          
        Returns:
        Current sequences value. Default value is null
      • setStartElement

        public void setStartElement(java.lang.String startElement)
                             throws java.lang.IllegalStateException
        The ID of either a sequence or an element which should be the starting point of the process. If not specified, the first sequence is chosen, or if there are no sequences, the first element. - log a warning and do nothing if there are neither sequences or elements
        Parameters:
        startElement - New startElement value. Default value is null
        Throws:
        java.lang.IllegalStateException - this property cannot be changed after the underlying component has been created
      • getStartElement

        public java.lang.String getStartElement()
        The ID of either a sequence or an element which should be the starting point of the process. If not specified, the first sequence is chosen, or if there are no sequences, the first element. - log a warning and do nothing if there are neither sequences or elements
        Returns:
        Current startElement value. Default value is null
      • setState

        public void setState(Record state)
        Current state of a process. As with Records in general, any field of a Record may contain a nested Record or Array of Records, so the process state is essentially a hierarchical data structure.

        Transient state

        In addition to the explicit process state there is a "transient state." The transient state represents the complete output of each of the last tasks of each type within the current process execution. This allows easy reference to the previous task output with taskInputExpressions.

        If this method is called after the component has been drawn/initialized: Set process state for current process
        Parameters:
        state - the new process state. Default value is null
      • getState

        public Record getState()
        Current state of a process. As with Records in general, any field of a Record may contain a nested Record or Array of Records, so the process state is essentially a hierarchical data structure.

        Transient state

        In addition to the explicit process state there is a "transient state." The transient state represents the complete output of each of the last tasks of each type within the current process execution. This allows easy reference to the previous task output with taskInputExpressions.
        Returns:
        Current state value. Default value is null
      • setTraceContext

        public void setTraceContext(java.util.Map traceContext)
        Context object to be passed to traceElement() during process execution.

        Note : This is an advanced setting

        Parameters:
        traceContext - New traceContext value. Default value is null
      • getTraceContext

        public java.util.Map getTraceContext()
        Context object to be passed to traceElement() during process execution.
        Returns:
        Current traceContext value. Default value is null
      • setWizard

        public void setWizard(java.lang.Boolean wizard)
                       throws java.lang.IllegalStateException
        If wizard is set then current workflow will be handled as wizard. Every userTask will hide associated form after user finished step.
        Parameters:
        wizard - New wizard value. Default value is false
        Throws:
        java.lang.IllegalStateException - this property cannot be changed after the underlying component has been created
      • getWizard

        public java.lang.Boolean getWizard()
        If wizard is set then current workflow will be handled as wizard. Every userTask will hide associated form after user finished step.
        Returns:
        Current wizard value. Default value is false
      • finished

        public void finished(Record state)
        StringMethod called when a process completes, meaning the process executes a ProcessElement with no next element.
        Parameters:
        state - the final process state
      • getElement

        public ProcessElement getElement(java.lang.String ID)
        Retrieve a ProcessElement by it's ID
        Parameters:
        ID - id of the process element
        Returns:
        the indicated process element, or null if no such element exists
      • reset

        public void reset(Record state)
        Reset process to it's initial state, so process can be started again.
        Parameters:
        state - new state of the process
      • start

        public void start()
        Starts this task by executing the startElement. Also used by asynchronous tasks to restart the workflow.
      • traceElement

        public void traceElement(Task element,
                                 java.util.Map context)
        StringMethod called during process execution before each task element is processed.
        Parameters:
        element - the Task being executed
        context - the traceContext, if set
      • getProcess

        public static Process getProcess(java.lang.String processId)
        Get a Process instance by it's ID. See loadProcess().
        Parameters:
        processId - process IDs to retrieve. See Identifier
        Returns:
        the process, or null if not loaded
        See Also:
        Identifier
      • setConfig

        public void setConfig(com.google.gwt.core.client.JavaScriptObject jsObj)
        Overrides:
        setConfig in class BaseClass
      • getElements

        public ProcessElement[] getElements()
        Elements involved in this Process. You can also group elements into sequences to reduce the need to explicitly define IDs for elements and interlink them.
        Returns:
        ProcessElement
      • setStartElement

        public void setStartElement(ProcessElement startElement)
                             throws java.lang.IllegalStateException
        Throws:
        java.lang.IllegalStateException
        See Also:
        setStartElement(String)
      • onInit_Process

        protected void onInit_Process()