flux.j2ee
Interface DynamicEjbEntityAction

All Superinterfaces:

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

public interface DynamicEjbEntityAction
extends EjbListener, J2eeAction, DynamicMethod

Invokes a method on an EJB entity bean home interface, which is responsible for returning one or more remote references. Afterwards, an optional method on each remote reference is invoked. These EJB entity bean remote references do not need to implement any specific interface.

The Dynamic EJB Entity Action returns its result in the same format as the EJB Entity Action. For more information on accessing and using the result, see EjbEntityAction.

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.
void	setListenerSignature(java.lang.String signature) Sets the optional method that receives a callback.

Methods inherited from interface flux.j2ee.EjbListener

getListenerHome, getListenerHomeAsString, getListenerJndiName, setListener

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

Methods inherited from interface flux.DynamicMethod

getArgument, getArgumentCount, getArgumentType, getListenerSignature, setArgument, setArgument, setArgument, setArgument, setArgument, setArgument, setArgument, setArgument, setArgument, setArgument, setArgument, setArgument, setArgument, setArgument, setArgument, setArgument, setArgument, setArgument, setArgument

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.

Returns:

A method on an EJB home interface.

Throws:

EngineException - If a system error occurs.

See Also:

setHomeMethod(flux.DynamicMethod), setListenerSignature(java.lang.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. When this action executes, an optional method on each of these remote references is called.

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, an optional method is invoked on it. If setListenerSignature() is not set, this optional method is not called.

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 optional method is invoked on each bean. Call setListenerSignature() to set the method that is to be invoked on each remote reference returned by the specified method on the EJB entity bean's home interface.

Parameters:

homeMethod - A method on an EJB home interface.

Throws:

EngineException - If a system error occurs.

See Also:

getHomeMethod(), setListenerSignature(java.lang.String)

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)

setListenerSignature

void setListenerSignature(java.lang.String signature)

Sets the optional method that receives a callback. For example, "doSomething(String s, Integer i)" is a valid signature for a method that might be declared like so.

public void doSomething(String s, Integer i) throws FileNotFoundException

Specified by:

setListenerSignature in interface DynamicMethod

Parameters:

signature - The method that receives the callback. The return type, parameter names, and exceptions thrown do not need to be specified.