flux

Interface ActionListener

public interface ActionListener

The listener interface for an action. Invoked when an action executes.

Author:

Copyright 2000-2025 Flux Corporation. All rights reserved.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	actionFired(KeyFlowContext flowContext) A callback method for when an action is to execute.

Method Detail

actionFired

java.lang.Object actionFired(KeyFlowContext flowContext)
                      throws java.lang.Exception

A callback method for when an action is to execute.

Parameters:

flowContext - The flow chart context in which this action is invoked.

Returns:

The result from the action listener, if any, which is placed into the flow context's variable manager. This result object is retrieved by successive triggers and actions by calling:

 String resultName = engineSource.useLastResult();
 Object myResult = flowContext.get(resultName);
 

The return value from flowContext.get() should be cast to the actual type of the result object.

Throws:

java.lang.Exception - If the action listener failed, in which case an error path is followed in the flow chart, not the normal path. If no error path is defined, the job finishes.