com.goldencode.p2j.util

Class InvocationRequestPayload

java.lang.Object

com.goldencode.p2j.util.InvocationRequestPayload

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable

public class InvocationRequestPayload
extends java.lang.Object
implements java.io.Externalizable

This payload is responsible for defining the details of a call into 4GL code, originating from a customer-specific application (used in cases when the client runs in an embedded mode, inside another application).

The invocation targets can be any external program, procedure or function which can be found in the user's propath; it is possible to also emulate a IN handle clause when targeting a procedure or function, by specifying the handle of an external program which was previously executed in persistent mode.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	InvocationRequestPayload.InvokeType The invocation types.

Field Summary

Fields

Modifier and Type	Field and Description
java.util.Map<java.lang.String,java.lang.String>	arguments A map with the arguments to be passed to the caller.
long	handle The handle ID.
java.lang.String	name The call target name; depending on the type, this is a name of an external program, procedure or function.
boolean	noError Flag indicating if this call should set the NO-ERROR mode on.
boolean	persistent When invoking an InvocationRequestPayload.InvokeType.EXTERNAL_PROGRAM, this flag will specify if the program will be ran persistent or not.
InvocationRequestPayload.InvokeType	type The call type.

Constructor Summary

Constructors

Constructor and Description
InvocationRequestPayload() Default constructor

Method Summary

Modifier and Type	Method and Description
void	readExternal(java.io.ObjectInput in) Replacement for the default object reading method.
void	writeExternal(java.io.ObjectOutput out) Replacement for the default object writing method.

Methods inherited from class java.lang.Object

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

Field Detail

noError

public boolean noError

Flag indicating if this call should set the NO-ERROR mode on.

name

public java.lang.String name

The call target name; depending on the type, this is a name of an external program, procedure or function.

handle

public long handle

The handle ID. Is used only when executing an internal procedure or function, in an external program ran persistent.

type

public InvocationRequestPayload.InvokeType type

The call type. See InvocationRequestPayload.InvokeType for the supported types.

arguments

public java.util.Map<java.lang.String,java.lang.String> arguments

A map with the arguments to be passed to the caller. The keys represent the legacy parameter names (case-insensitive) as defined in the name_map.xml file, and the values hold the string-representation of the argument's value. At invocation, the values will be converted to a value with the type specific to that argument.

persistent

public boolean persistent

When invoking an InvocationRequestPayload.InvokeType.EXTERNAL_PROGRAM, this flag will specify if the program will be ran persistent or not.

Constructor Detail

InvocationRequestPayload

public InvocationRequestPayload()

Default constructor

Method Detail

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Replacement for the default object reading method. The request data is read from the input source.

Specified by:

readExternal in interface java.io.Externalizable

Parameters:

in - The input source from which fields will be restored.

Throws:

java.io.IOException - In case of I/O errors.

java.lang.ClassNotFoundException - If payload can't be instantiated.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Replacement for the default object writing method. The request data is written to the output destination.

Specified by:

writeExternal in interface java.io.Externalizable

Parameters:

out - The output destination to which the fields will be saved.

Throws:

java.io.IOException - In case of I/O errors.