org.apache.myfaces.orchestra.flow.config
Class FlowParamAccept

java.lang.Object
  org.apache.myfaces.orchestra.flow.config.FlowParamAccept

All Implemented Interfaces:

Serializable

public class FlowParamAccept
extends Object
implements Serializable

Defines how a parameter value provided by a flow caller is imported into the called flow's environment.

See Also:

Serialized Form

Constructor Summary

FlowParamAccept()
Constructor.

Method Summary

String	getConverter() An optional EL expression which maps to a FlowTypeConverter instance that will be used to transform the input parameter before it is assigned to dst.
String	getDflt() An EL expression which defines a default value to use when the caller does not specify a value for this input parameter.
Object	getDfltValue(javax.faces.context.FacesContext facesContext) Evaluate the src EL expression and return the resulting object (or null).
String	getDst() An EL expression which defines where the actual value passed by the caller should be stored within the called flow's environment.
String	getName() Define the name of this parameter.
void	setConverter(String converter) For use only during object initialization.
void	setDflt(String dflt) For use only during object initialization.
void	setDst(String expr) For use only during object initialization.
void	setDstValue(javax.faces.context.FacesContext facesContext, Object newValue)
void	setName(String name) For use only during object initialization.
void	validate() Check that all the properties of this object have valid values, ie whether the configuration specified by the user is valid.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FlowParamAccept

public FlowParamAccept()

Constructor.

Method Detail

validate

public void validate()

Check that all the properties of this object have valid values, ie whether the configuration specified by the user is valid.

getName

public String getName()

Define the name of this parameter.

The caller is expected to define a parameter with a matching name; it is an error for the caller to not provide a matching value - unless this object has a non-null dflt property.

Null is never returned.

setName

public void setName(String name)

For use only during object initialization.

getDst

public String getDst()

An EL expression which defines where the actual value passed by the caller should be stored within the called flow's environment.

Null is never returned.

setDst

public void setDst(String expr)

For use only during object initialization.

setDstValue

public void setDstValue(javax.faces.context.FacesContext facesContext,
                        Object newValue)

getDflt

public String getDflt()

An EL expression which defines a default value to use when the caller does not specify a value for this input parameter.

Optional; if this is not defined then an error is reported if a caller does not provide an actual value for this named parameter.

Note that this EL expression is evaluated within the environment of the called flow, not the caller.

setDflt

public void setDflt(String dflt)

For use only during object initialization.

getDfltValue

public Object getDfltValue(javax.faces.context.FacesContext facesContext)

Evaluate the src EL expression and return the resulting object (or null).

getConverter

public String getConverter()

An optional EL expression which maps to a FlowTypeConverter instance that will be used to transform the input parameter before it is assigned to dst.

Note that this EL expression is evaluated within the environment of the called flow, not the caller.

setConverter

public void setConverter(String converter)

For use only during object initialization.