Method catch

SpiffWorkflow/bpmn/workflow.py:107–132

Tasks can always catch events, regardless of their state. The event information is stored in the task's internal data and processed when the task is reached in the workflow. If a task should only receive messages while it is running (eg a boundary event), the task should c

(self, event)

        return [sp for sp in self.subprocesses.values() if not sp.completed]

    def catch(self, event):
        """
        Tasks can always catch events, regardless of their state.  The event information is stored in the task's
        internal data and processed when the task is reached in the workflow.  If a task should only receive messages
        while it is running (eg a boundary event), the task should call the event_definition's reset method before
        executing to clear out a stale message.

        :param event: the thrown event
        """
        if event.target is not None:
            # This limits results to tasks in the specified workflow
            tasks = event.target.get_tasks(skip_subprocesses=True, state=TaskState.NOT_FINISHED_MASK, catches_event=event)
            if isinstance(event.event_definition, CodeEventDefinition) and len(tasks) == 0:
                event.target = event.target.parent_workflow
                self.catch(event)
        else:
            self.update_collaboration(event)
            tasks = self.get_tasks(state=TaskState.NOT_FINISHED_MASK, catches_event=event)
            # Figure out if we need to create an external event
            if len(tasks) == 0:
                self.bpmn_events.append(event)

        for task in tasks:
            task.task_spec.catch(task, event)
        if len(tasks) > 0:
            self.refresh_waiting_tasks()

    def send_event(self, event):
        """Allows this workflow to catch an externally generated event."""