org.mmbase.bridge.remote.proxy

Class RemoteFunction_Proxy<R>

java.lang.Object

org.mmbase.bridge.remote.proxy.MappedObject_Proxy<RemoteFunction<R>>

org.mmbase.bridge.remote.proxy.RemoteFunction_Proxy<R>

All Implemented Interfaces:

MappedObject, Function<R>

public class RemoteFunction_Proxy<R>
extends MappedObject_Proxy<RemoteFunction<R>>
implements Function<R>

RemoteFunction_Proxy in a generated smart proxy of Function
This smart proxy is used by a local class when the MMCI is called remotely

Author:

generated by org.mmbase.mojo.remote.ProxyGenerator

Constructor Summary

Constructors

Constructor and Description
RemoteFunction_Proxy(RemoteFunction<R> remoteObject)

Method Summary

Modifier and Type	Method and Description
Parameters	createParameters() Creates an empty 'Parameters' object for you, which you have to fill and feed back to getFunctionValue
String	getDescription()
R	getFunctionValue(Parameters arg0) Executes the defined function supplying the given arguments.
R	getFunctionValueWithList(List<?> arg0) Executes the defined function supplying the given List of arguments.
String	getName() A function must have a name.
Parameter<?>[]	getParameterDefinition()
ReturnType<R>	getReturnType()
RemoteFunction<R>	getWrappedObject()
void	setDescription(String arg0) For documentational purposes a function object needs a description too.
void	setParameterDefinition(Parameter<?>[] arg0) A function object is of no use, as long as it lacks a definition.
void	setReturnType(ReturnType<R> arg0) Sets the return type of the function's result value.

Methods inherited from class org.mmbase.bridge.remote.proxy.MappedObject_Proxy

equals, getMapperCode, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RemoteFunction_Proxy

public RemoteFunction_Proxy(RemoteFunction<R> remoteObject)

Method Detail

createParameters

public Parameters createParameters()

Description copied from interface: Function

Creates an empty 'Parameters' object for you, which you have to fill and feed back to getFunctionValue

Specified by:

createParameters in interface Function<R>

See Also:

Function.getFunctionValue(Parameters)

getFunctionValue

public R getFunctionValue(Parameters arg0)

Description copied from interface: Function

Executes the defined function supplying the given arguments.

Specified by:

getFunctionValue in interface Function<R>

Parameters:

arg0 - The parameters for the function. To specify an empty parameter list use Parameters.VOID. Implementors are encouraged to support null too.

Returns:

The function value, which can be of any type compatible to Function.getReturnType()

See Also:

Function.createParameters()

getFunctionValueWithList

public R getFunctionValueWithList(List<?> arg0)

Description copied from interface: Function

Executes the defined function supplying the given List of arguments. This is a convenience method, as the List is mapped to a Parameters type and passed to Function.getFunctionValue(Parameters).

Specified by:

getFunctionValueWithList in interface Function<R>

Parameters:

arg0 - The parameters for the function. To specify an empty parameter list use Parameters.VOID.

Returns:

The function value, which can be of any type compatible to Function.getReturnType()

getParameterDefinition

public Parameter<?>[] getParameterDefinition()

Specified by:

getParameterDefinition in interface Function<R>

Returns:

The currently set Parameter definition array, or null if not set already.

setParameterDefinition

public void setParameterDefinition(Parameter<?>[] arg0)

Description copied from interface: Function

A function object is of no use, as long as it lacks a definition.

Specified by:

setParameterDefinition in interface Function<R>

Parameters:

arg0 - An array of Parameter objects.

setReturnType

public void setReturnType(ReturnType<R> arg0)

Description copied from interface: Function

Sets the return type of the function's result value.

Specified by:

setReturnType in interface Function<R>

Parameters:

arg0 - A ReturnType object. For void functions that could be ReturnType.VOID.

getDescription

public String getDescription()

Specified by:

getDescription in interface Function<R>

See Also:

Function.setDescription(String)

setDescription

public void setDescription(String arg0)

Description copied from interface: Function

For documentational purposes a function object needs a description too.

Specified by:

setDescription in interface Function<R>

getName

public String getName()

Description copied from interface: Function

A function must have a name. This is the name which was used to aquire the function object.

Specified by:

getName in interface Function<R>

Returns:

The function's name, never null

getReturnType

public ReturnType<R> getReturnType()

Specified by:

getReturnType in interface Function<R>

Returns:

The return type of the function's result value, or null if unknown.

getWrappedObject

public RemoteFunction<R> getWrappedObject()

Specified by:

getWrappedObject in interface MappedObject

Overrides:

getWrappedObject in class MappedObject_Proxy<RemoteFunction<R>>