com.goldencode.p2j.util

Class InvocationResponsePayload

java.lang.Object

com.goldencode.p2j.util.InvocationResponsePayload

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable

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

This class holds the data for a response, after invoking a 4GL external program, procedure or function, and associated with a request incoming from a customer-specific application.

The response contains details for the handle ID (in case of an external program ran persistent), values for OUTPUT/INPUTPUT arguments, function (or procedure)'s return value, state of any ERROR, QUIT or STOP conditions.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
boolean	error Flag indicating if the request ended with an ERROR condition.
java.lang.String	errorMessage If error flag is true, this represents the error message.
int	errorNumber If error flag is true, this represents the error number.
long	handle When running an external program in persistent mode, this is the handle ID associated with the resource of that external program.
java.util.Map<java.lang.String,java.lang.String>	outputArguments This map holds the string-representation of all OUTPUT or INPUT-OUTPUT arguments, as resulted after the request was performed.
boolean	quit Flag indicating if the request ended with a QUIT condition.
java.lang.String	returnValue In case of functions, this will hold the value returned by the function.
boolean	stop Flag indicating if the request ended with a STOP condition.

Constructor Summary

Constructors

Constructor and Description
InvocationResponsePayload() 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

handle

public long handle

When running an external program in persistent mode, this is the handle ID associated with the resource of that external program.

outputArguments

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

This map holds the string-representation of all OUTPUT or INPUT-OUTPUT arguments, as resulted after the request was performed.

returnValue

public java.lang.String returnValue

In case of functions, this will hold the value returned by the function. Otherwise, this value is the same value as the RETURN-VALUE 4GL function would return, after the call of an external program or internal procedure.

error

public boolean error

Flag indicating if the request ended with an ERROR condition.

errorNumber

public int errorNumber

If error flag is true, this represents the error number.

errorMessage

public java.lang.String errorMessage

If error flag is true, this represents the error message.

quit

public boolean quit

Flag indicating if the request ended with a QUIT condition.

stop

public boolean stop

Flag indicating if the request ended with a STOP condition.

Constructor Detail

InvocationResponsePayload

public InvocationResponsePayload()

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 response 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 response 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.