flux.j2ee
Interface EjbEntityAction

All Superinterfaces:

Action, java.lang.Cloneable, EjbListener, J2eeAction, J2eeKeyAction, RuntimeDataMap, java.io.Serializable

public interface EjbEntityAction
extends EjbListener, J2eeKeyAction

Invokes a method on an EJB entity bean home interface, which is responsible for returning one or more remote references. Afterwards, a method on each remote reference is invoked.

The EJB Entity 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.util.List	A List containing the return value for each method call on the remote references for this EJB action. The List may be empty, but it will never be null.

Author:

Copyright 2014 Flux Corporation. All rights reserved.

Method Summary

DynamicMethod	getHomeMethod() Returns a method on an EJB home interface, which is responsible for returning one or more remote references.
void	setHomeMethod(DynamicMethod homeMethod) Sets a method on an EJB home interface, which is responsible for returning one or more remote references.
void	setListener(java.lang.String jndiName, java.lang.Class home) Sets the JNDI name and class of an EJB home interface.

Methods inherited from interface flux.j2ee.EjbListener

getListenerHome, getListenerHomeAsString, getListenerJndiName, setListener

Methods inherited from interface flux.j2ee.J2eeKeyAction

getKey, setKey

Methods inherited from interface flux.j2ee.J2eeAction

getExtraInitialContextProperties, getInitialContextFactory, getPassword, getProviderUrl, getUsername, setExtraInitialContextProperties, setInitialContextFactory, setPassword, setProviderUrl, setUsername

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

getHomeMethod

DynamicMethod getHomeMethod()
                            throws EngineException

Returns a method on an EJB home interface, which is responsible for returning one or more remote references. Each of these remote references must implement the flux.RemoteActionListener interface. When executed, this action invokes the actionFired() method on each of these remote references.

Returns:

A method on an EJB home interface.

Throws:

EngineException - If a system error occurs.

See Also:

setHomeMethod(flux.DynamicMethod), RemoteActionListener

setListener

void setListener(java.lang.String jndiName,
                 java.lang.Class home)

Sets the JNDI name and class of an EJB home interface. The home interface must be an EJB entity bean home interface.

Specified by:

setListener in interface EjbListener

Parameters:

jndiName - The JNDI name for the EJB's home interface.

home - The class name of the EJB's home interface.

See Also:

EjbListener.setListener(String, String)

setHomeMethod

void setHomeMethod(DynamicMethod homeMethod)
                   throws EngineException

Sets a method on an EJB home interface, which is responsible for returning one or more remote references. Each of these remote references must implement the flux.RemoteActionListener interface. When executed, this action invokes the actionFired() method on each of these remote references.

For example, to create an EJB entity bean, set a create() home method. It can be the default create() method or a custom create() method. After the entity bean is created, the actionFired() method in flux.RemoteActionListener is invoked on it.

As another example, to call a finder on a home interface and invoke a method on each remote reference in the the entire collection that is returned, set a findByMyCriteria() home method. After the entity beans are returned, the actionFired() method in flux.RemoteActionListener is invoked on each bean.

Parameters:

homeMethod - A method on an EJB home interface.

Throws:

EngineException - If a system error occurs.

See Also:

getHomeMethod(), RemoteActionListener