Interface WorkflowExternalProcess

    • Method Detail

      • execute

        java.io.Serializable execute​(WorkItem item,
                                     WorkflowSession session,
                                     MetaDataMap arguments)
                              throws WorkflowException
        Executes the external process step. In order to keep track of this asynchronous process, an identifier must be returned. One can return null to indicate that nothing was executed. In this case, the step directly advances to the next step.
        Parameters:
        item - The current work item
        session - The current workflow session
        arguments - The current steps node arguments (aka as node meta data)
        Returns:
        Any serializable identifier for the external process executed, or null
        Throws:
        WorkflowException - When an error is encountered
      • hasFinished

        boolean hasFinished​(java.io.Serializable externalProcessId,
                            WorkItem item,
                            WorkflowSession session,
                            MetaDataMap arguments)
        Tests the external process, given by the external process id, for completeness.
        Parameters:
        externalProcessId - The external process to test for completeness
        item - The current work item
        session - The current workflow session
        arguments - The current steps node arguments (aka as node meta data)
        Returns:
        boolean Returns True or False if process has finished
      • handleResult

        void handleResult​(java.io.Serializable externalProcessId,
                          WorkItem workItem,
                          WorkflowSession session,
                          MetaDataMap arguments)
                   throws WorkflowException
        Get and handle the result of the external process, given by the external process id. This would include storing any results where appropriate for further use.
        Parameters:
        externalProcessId - The external process to handle the results for
        workItem - The current work item
        session - The current workflow session
        arguments - The current steps node arguments (aka as node meta data)
        Throws:
        WorkflowException - When an error is encountered