flux
Interface RemoteActionListener

public interface RemoteActionListener

The listener interface for a remote action. Invoked when a remote action executes.

Author:

Copyright 2014 Flux Corporation. All rights reserved.

Method Summary

java.lang.Object

actionFired(RemoteKeyFlowContext flowContext) A callback method for when a remote action is to execute.

Method Detail

actionFired

java.lang.Object actionFired(RemoteKeyFlowContext flowContext)
                             throws java.lang.Exception,
                                    java.rmi.RemoteException

A callback method for when a remote 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.

java.rmi.RemoteException - If a networking error occurs, in which case the error path is followed.