org.fujion.client

Class ClientInvocation

java.lang.Object

org.fujion.client.ClientInvocation

public class ClientInvocation
extends Object

Represents a function invocation request to be sent to the client.

Constructor Summary

Constructors

Constructor and Description
ClientInvocation(IElementIdentifier target, String function, Object... arguments) Create a client invocation request.
ClientInvocation(String moduleName, String function, Object... arguments) Create a client invocation request.

Method Summary

Modifier and Type	Method and Description
String	getKey() Returns the key associated with the client invocation request.
Map<String,Object>	toMap() Packages the client invocation request as a map for serialization and transport.

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientInvocation

public ClientInvocation(IElementIdentifier target,
                        String function,
                        Object... arguments)

Create a client invocation request.

Parameters:

target - The identifier of the widget that implements the function being invoked. If null is specified, the function name must specify a fully qualified path to a free-standing function.

function - The name of the function to be invoked. This may be one of the following formats:

[key]^[function name]	- The key and the function name are explicitly declared.
^[function name]	- The key is implied to be the same as the function name.
[function name]	- The key will default to a unique value.

arguments - Optional arguments to be passed to the function.

ClientInvocation

public ClientInvocation(String moduleName,
                        String function,
                        Object... arguments)

Create a client invocation request.

Parameters:

moduleName - The name of the module whose exported function is to be invoked. If null is specified, the function name must specify a fully qualified path to a free-standing function.

function - The name of the exported function to be invoked. This may be one of the following formats:

[key]^[function name]	- The key and the function name are explicitly declared.
^[function name]	- The key is implied to be the same as the function name.
[function name]	- The key will default to a unique value.

arguments - Optional arguments to be passed to the function.

Method Detail

getKey

public String getKey()

Returns the key associated with the client invocation request. This key is used when queuing the request. If a client invocation request with a matching key already exists in the queue, it will be replaced by this one.

Returns:

The key of the client invocation request.

toMap

public Map<String,Object> toMap()

Packages the client invocation request as a map for serialization and transport.

Returns:

Client invocation request as a map.