no.g9.client.core.action

Interface ParameterBinding<A>

Type Parameters:

A - the actual parameter type.

public interface ParameterBinding<A>

Represents a parameter binding in a remote service invocation. A parameter binding consists of a formal parameter, an actual parameter and possibly a converter.

1. The actual parameter is the model type of the parameter binding, e.g. an object selection role, a role-attribute or a constant.
2. The formal parameter is the declared interface-method attribute.
3. A converter might be used to covert between actual and formal parameter.

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	RETURN_VALUE Boolean constant denoting that a parameter binding is in fact a return value.

Method Summary

Modifier and Type	Method and Description
Parameter<A>	getActualParameter() Get the actual parameter of this parameter binding.
<F> A	getActualParameterValue(F formalParameterValue) Get the actual parameter value of this parameter binding.
Converter<A,?>	getConverter() Return the converter to use with this remote service parameter.
String	getFormalParameterName() Get the declared name of the formal parameter
<F> F	getFormalParameterValue() Get the formal parameter value of this parameter binding.
boolean	hasConverter() Test if this remote service parameter has a registered converter.
boolean	isReturnValue() Test if this parameter binding represents the return value.
A	obtainParameterValue() Obtain the actual parameter value.
void	setActualParameterValue(A actualParameterValue) Set the actual parameter value.
<F> void	setFormalParameterValue(F formalParameterValue) Set the formal parameter value.

Field Detail

RETURN_VALUE

static final boolean RETURN_VALUE

Boolean constant denoting that a parameter binding is in fact a return value.

See Also:

Constant Field Values

Method Detail

hasConverter

boolean hasConverter()

Test if this remote service parameter has a registered converter.

Returns:

true if the remote service parameter has a converter

getConverter

Converter<A,?> getConverter()

Return the converter to use with this remote service parameter. The converter is used to convert between actual parameter (the converter's model type) type and formal parameter type (the converter's target type).

Returns:

the converter or null if no such converter exists.

getActualParameter

Parameter<A> getActualParameter()

Get the actual parameter of this parameter binding.

Returns:

the actual parameter.

getFormalParameterName

String getFormalParameterName()

Get the declared name of the formal parameter

Returns:

the formal parameter name.

isReturnValue

boolean isReturnValue()

Test if this parameter binding represents the return value.

Returns:

true if this binding is the return value.

getFormalParameterValue

<F> F getFormalParameterValue()
                       throws ConvertException

Get the formal parameter value of this parameter binding. If this parameter binding has a converter, the actual parameter value will be converted and returned. Otherwise the actual parameter value will be casted to the formal parameter type and returned.

Note that unless the the parameter has been obtained, or the actual parameter is a constant, the parameter returned value will most likely be null (depending on the converter).

Type Parameters:

F - the formal parameter type.

Returns:

the converted parameter value.

Throws:

ConvertException - exceptions thrown by converter are re-thrown.

getActualParameterValue

<F> A getActualParameterValue(F formalParameterValue)
                       throws ConvertException

Get the actual parameter value of this parameter binding. If the parameter binding has a converter, the formal parameter value will be converted and returned. Otherwise the formal parameter value will be casted to the actual parameter type and returned.

Type Parameters:

F - the formal parameter type

Parameters:

formalParameterValue - the formal parameter value

Returns:

the actual parameter value

Throws:

ConvertException - exceptions thrown by converter are re-thrown.

setActualParameterValue

void setActualParameterValue(A actualParameterValue)

Set the actual parameter value.

Parameters:

actualParameterValue - the value of the actual parameter.

setFormalParameterValue

<F> void setFormalParameterValue(F formalParameterValue)
                          throws ConvertException

Set the formal parameter value. If the parameter binding has a converter, the formal parameter value will be converted to the actual parameter type.

Type Parameters:

F - the formal parameter type.

Parameters:

formalParameterValue - the formal parameter value.

Throws:

ConvertException - exceptions thrown by converter are re-thrown.

obtainParameterValue

A obtainParameterValue()

Obtain the actual parameter value.

Returns:

the obtained value