flux
Interface JavaAction

All Superinterfaces:

Action, java.lang.Cloneable, RuntimeDataMap, java.io.Serializable

public interface JavaAction
extends Action

Creates a Java object from a class, then invokes a method on the newly created object. The class must implement the flux.ActionListener interface. When the job executes this action, the object returned by the listener is added to the flow context.

At a minimum, a listener must be set when initializing a Java action.

The Java Action returns its result in the flow context variable "RESULT". The following table contains more information on accessing and using the result.

Flow Context Variable	Java Type	Description
RESULT	java.lang.Object	The object returned from the actionFired() method of the listener that this Java Action invokes.

Author:

Copyright 2014 Flux Corporation. All rights reserved.

Method Summary

java.lang.Object	getKey() Returns optional data that is passed to the Java object to provide context as it is invoked.
java.lang.Class	getListener() Returns the listener that receives a callback.
java.lang.String	getListenerAsString() Returns the listener that receives a callback.
void	setKey(java.lang.Object key) Sets optional data that is passed to the Java object to provide context as it is invoked.
void	setListener(java.lang.Class listener) Sets the listener that receives a callback.
void	setListenerAsString(java.lang.String listener) Sets the listener that receives a callback.

Methods inherited from interface flux.Action

addFlow, addFlow, addSignalFlow, clone, execute, getDescription, getFlows, getHiddenVariableNames, getJoinExpression, getName, getPostscript, getPostscriptLanguage, getPrescript, getPrescriptLanguage, getResultInfo, getSignalsToMonitor, getTimeoutBusinessInterval, getTimeoutBusinessIntervalNamespace, getTimeoutExpression, getVariableManager, isEndOfRun, isJoinPoint, isSkippable, isStartAction, isStartOfRun, isTransactionBreak, removeFlow, reset, setDescription, setElseFlow, setEndOfRun, setErrorFlow, setErrorFlowWithoutRollback, setErrorFlowWithRollback, setJoinExpression, setJoinPoint, setName, setPostscript, setPostscriptLanguage, setPrescript, setPrescriptLanguage, setSignalsToMonitor, setSkippable, setStartAction, setStartOfRun, setTimeoutBusinessInterval, setTimeoutBusinessIntervalNamespace, setTimeoutExpression, setTimeoutFlow, setTransactionBreak, verify, verifyOnClient

Methods inherited from interface flux.runtimedatamap.RuntimeDataMap

getRuntimeDataMap, setRuntimeDataMap

Method Detail

getKey

java.lang.Object getKey()

Returns optional data that is passed to the Java object to provide context as it is invoked.

Returns:

Optional data that is passed to the Java object to provide context as it is invoked.

getListener

java.lang.Class getListener()
                            throws EngineException

Returns the listener that receives a callback. Returns the same Listener property as getListenerAsString().

Returns:

The listener that receives a callback.

Throws:

EngineException - If a system error occurs.

See Also:

ActionListener, getListenerAsString()

getListenerAsString

java.lang.String getListenerAsString()

Returns the listener that receives a callback. Returns the same Listener property as getListener().

Returns:

The fully-qualified name of the listener class that receives a callback.

See Also:

ActionListener, getListener()

setKey

void setKey(java.lang.Object key)

Sets optional data that is passed to the Java object to provide context as it is invoked.

Parameters:

key - Optional data that is passed to the Java object to provide context as it is invoked.

setListener

void setListener(java.lang.Class listener)

Sets the listener that receives a callback. Sets the same Listener property as setListenerAsString().

Parameters:

listener - The listener that receives a callback. The listener class must implement the flux.ActionListener interface.

See Also:

ActionListener, setListenerAsString(java.lang.String)

setListenerAsString

void setListenerAsString(java.lang.String listener)

Sets the listener that receives a callback. Sets the same Listener property as setListener().

Parameters:

listener - The fully-qualified name of the listener class that receives a callback. The listener class must implement the flux.ActionListener interface.

See Also:

ActionListener, setListener(java.lang.Class)