AppServerInvocationResult (P2J - Progress 4GL to Java Conversion and Runtime)

java.lang.Object
- com.goldencode.p2j.main.RemoteInvocationResult
- - com.goldencode.p2j.main.AppServerInvocationResult

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable
```
public class AppServerInvocationResult
extends RemoteInvocationResult
implements java.io.Externalizable
```
This class acts as a container for the various data which is returned by or updated during remote appserver calls. This includes the function/procedure return value, updated OUTPUT/INPUT-OUTPUT parameters or the persistent procedure handle for a RUN ... PERSISTENT call.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`private java.lang.Integer`	`agentId` The response for the `OERequestInfo:agentId` value.
`private java.lang.String`	`clientContextId` The response for the `OERequestInfo:clientContextId` value.
`private byte[]`	`clientPrincipal` The response for the `OERequestInfo:clientPrincipal` value.
`private java.lang.String`	`clientType` The response for the `OERequestInfo:versionInfo` value.
`private java.lang.String`	`connectionID` The connection ID, returned during the connect request.
`private boolean`	`invalidInHandle` Flag indicating that the requester's IN HANDLE has been deleted by the remote side.
`private java.lang.String`	`procedureId` The remote procedure handle, used to build a `ProxyProcedureWrapper` instance.
`private java.lang.String`	`requestId` The response for the `OERequestInfo:requestId` value.
`private java.lang.Integer`	`sessionId` The response for the `OERequestInfo:sessionId` value.
`private java.lang.Integer`	`threadId` The response for the `OERequestInfo:threadId` value.
`private java.lang.String[]`	`versionInfo` The response for the `OERequestInfo:versionInfo` value.

Fields inherited from class com.goldencode.p2j.main.RemoteInvocationResult
arguments, error, modes, result

Constructor Summary

Constructors
Constructor and Description

AppServerInvocationResult()

Constructors
Constructor and Description
`AppServerInvocationResult()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.Integer`	`getAgentId()` Get the `agentId`.
`java.lang.String`	`getClientContextId()` Get the `clientContextId`.
`byte[]`	`getClientPrincipal()` Get the `clientPrincipal`.
`java.lang.String`	`getClientType()` Get the `clientType`.
`java.lang.String`	`getConnectionID()` Get the established connection ID, for a connect request.
`java.lang.String`	`getProcedureId()` Get the handle code for the remote persistent procedure.
`java.lang.String`	`getRequestId()` Get the `requestId`.
`java.lang.Integer`	`getSessionId()` Get the `sessionId`.
`java.lang.Integer`	`getThreadId()` Get the `threadId`.
`java.lang.String[]`	`getVersionInfo()` Get the `versionInfo`.
`boolean`	`isInvalidInHandle()` Get the state of the `invalidInHandle` flag.
`void`	`readExternal(java.io.ObjectInput in)` Used the specified input source and initialize this instance.
`void`	`setAgentId(java.lang.Integer agentId)` Set the `agentId`.
`void`	`setClientContextId(java.lang.String clientContextId)` Set the `clientContextId`.
`void`	`setClientPrincipal(byte[] clientPrincipal)` Set the `clientPrincipal`.
`void`	`setClientType(java.lang.String clientType)` Set the `clientType`.
`void`	`setConnectionID(java.lang.String connectionID)` Set the new connection ID, after a connect request.
`void`	`setInvalidInHandle(boolean invalidInHandle)` Set the state of the `invalidInHandle` flag.
`void`	`setProcedureId(java.lang.String procedureId)` Save the remote persistent procedure handle's code.
`void`	`setRequestId(java.lang.String requestId)` Set the `requestId`.
`boolean`	`setReturnValue()` Check if the RETURN-VALUE will be set.
`void`	`setSessionId(java.lang.Integer sessionId)` Set the `sessionId`.
`void`	`setThreadId(java.lang.Integer threadId)` Set the `threadId`.
`void`	`setVersionInfo(java.lang.String[] versionInfo)` Set the `versionInfo`.
`void`	`storeResponse(object<? extends OerequestInfo> currentResponseInfo)` Store a `OerequestInfo` response from the appserver agent, to be sent to the caller.
`void`	`writeExternal(java.io.ObjectOutput out)` Serialize this object, to be picked up by the other side.

Methods inherited from class com.goldencode.p2j.main.RemoteInvocationResult
getArguments, getError, getModes, getResult, setArguments, setError, setModes, setResult

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - procedureId
```
private java.lang.String procedureId
```
    The remote procedure handle, used to build a ProxyProcedureWrapper instance.
  - connectionID
```
private java.lang.String connectionID
```
    The connection ID, returned during the connect request.
  - clientContextId
```
private java.lang.String clientContextId
```
    The response for the OERequestInfo:clientContextId value.
  - requestId
```
private java.lang.String requestId
```
    The response for the OERequestInfo:requestId value.
  - versionInfo
```
private java.lang.String[] versionInfo
```
    The response for the OERequestInfo:versionInfo value.
  - clientType
```
private java.lang.String clientType
```
    The response for the OERequestInfo:versionInfo value.
  - agentId
```
private java.lang.Integer agentId
```
    The response for the OERequestInfo:agentId value.
  - sessionId
```
private java.lang.Integer sessionId
```
    The response for the OERequestInfo:sessionId value.
  - threadId
```
private java.lang.Integer threadId
```
    The response for the OERequestInfo:threadId value.
  - clientPrincipal
```
private byte[] clientPrincipal
```
    The response for the OERequestInfo:clientPrincipal value.
  - invalidInHandle
```
private boolean invalidInHandle
```
    Flag indicating that the requester's IN HANDLE has been deleted by the remote side.
- Constructor Detail
  - AppServerInvocationResult
```
public AppServerInvocationResult()
```
- Method Detail
  - writeExternal
```
public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException
```
    Serialize this object, to be picked up by the other side.
    
    Specified by:
    
    writeExternal in interface java.io.Externalizable
    
    Parameters:
    
    out - The output destination to which the data will be sent.
    
    Throws:
    
    java.io.IOException - In case of I/O errors.
  - readExternal
```
public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException
```
    Used the specified input source and initialize this instance.
    
    Specified by:
    
    readExternal in interface java.io.Externalizable
    
    Parameters:
    
    in - The input source from which the data will be restored.
    
    Throws:
    
    java.io.IOException - In case of I/O errors.
    
    java.lang.ClassNotFoundException - If payload can't be instantiated.
  - isInvalidInHandle
```
public boolean isInvalidInHandle()
```
    Get the state of the invalidInHandle flag.
    
    Returns:
    
    See above.
  - setInvalidInHandle
```
public void setInvalidInHandle(boolean invalidInHandle)
```
    Set the state of the invalidInHandle flag.
    
    Parameters:
    
    invalidInHandle - The new flag value.
  - getProcedureId
```
public java.lang.String getProcedureId()
```
    Get the handle code for the remote persistent procedure.
    
    Returns:
    
    The procedureId field.
  - setProcedureId
```
public void setProcedureId(java.lang.String procedureId)
```
    Save the remote persistent procedure handle's code.
    
    Parameters:
    
    procedureId - The code for the remote persistent procedure handle.
  - getConnectionID
```
public java.lang.String getConnectionID()
```
    Get the established connection ID, for a connect request.
    
    Returns:
    
    See above.
  - setConnectionID
```
public void setConnectionID(java.lang.String connectionID)
```
    Set the new connection ID, after a connect request.
    
    Parameters:
    
    connectionID - The connection ID, which will be unknown if there are any errors.
  - setReturnValue
```
public boolean setReturnValue()
```
    Check if the RETURN-VALUE will be set.
    
    Overrides:
    
    setReturnValue in class RemoteInvocationResult
    
    Returns:
    
    In case of appserver results, it returns true.
  - getClientContextId
```
public java.lang.String getClientContextId()
```
    Get the clientContextId.
    
    Returns:
    
    See above.
  - setClientContextId
```
public void setClientContextId(java.lang.String clientContextId)
```
    Set the clientContextId.
    
    Parameters:
    
    clientContextId - The clientContextId to set
  - getRequestId
```
public java.lang.String getRequestId()
```
    Get the requestId.
    
    Returns:
    
    See above.
  - setRequestId
```
public void setRequestId(java.lang.String requestId)
```
    Set the requestId.
    
    Parameters:
    
    requestId - The requestId to set
  - getVersionInfo
```
public java.lang.String[] getVersionInfo()
```
    Get the versionInfo.
    
    Returns:
    
    See above.
  - setVersionInfo
```
public void setVersionInfo(java.lang.String[] versionInfo)
```
    Set the versionInfo.
    
    Parameters:
    
    versionInfo - The versionInfo to set
  - getClientType
```
public java.lang.String getClientType()
```
    Get the clientType.
    
    Returns:
    
    See above.
  - setClientType
```
public void setClientType(java.lang.String clientType)
```
    Set the clientType.
    
    Parameters:
    
    clientType - The clientType to set
  - getAgentId
```
public java.lang.Integer getAgentId()
```
    Get the agentId.
    
    Returns:
    
    See above.
  - setAgentId
```
public void setAgentId(java.lang.Integer agentId)
```
    Set the agentId.
    
    Parameters:
    
    agentId - The agentId to set
  - getSessionId
```
public java.lang.Integer getSessionId()
```
    Get the sessionId.
    
    Returns:
    
    See above.
  - setSessionId
```
public void setSessionId(java.lang.Integer sessionId)
```
    Set the sessionId.
    
    Parameters:
    
    sessionId - The sessionId to set
  - getThreadId
```
public java.lang.Integer getThreadId()
```
    Get the threadId.
    
    Returns:
    
    See above.
  - setThreadId
```
public void setThreadId(java.lang.Integer threadId)
```
    Set the threadId.
    
    Parameters:
    
    threadId - The threadId to set
  - getClientPrincipal
```
public byte[] getClientPrincipal()
```
    Get the clientPrincipal.
    
    Returns:
    
    See above.
  - setClientPrincipal
```
public void setClientPrincipal(byte[] clientPrincipal)
```
    Set the clientPrincipal.
    
    Parameters:
    
    clientPrincipal - The clientPrincipal to set
  - storeResponse
```
public void storeResponse(object<? extends OerequestInfo> currentResponseInfo)
```
    Store a OerequestInfo response from the appserver agent, to be sent to the caller.
    
    Parameters:
    
    currentResponseInfo - The SESSION:CURRENT-RESPONSE-INFO instance.

Class AppServerInvocationResult

Field Summary

Fields inherited from class com.goldencode.p2j.main.RemoteInvocationResult

Constructor Summary

Method Summary

Methods inherited from class com.goldencode.p2j.main.RemoteInvocationResult

Methods inherited from class java.lang.Object

Field Detail

procedureId

connectionID

clientContextId

requestId

versionInfo

clientType

agentId

sessionId

threadId

clientPrincipal

invalidInHandle

Constructor Detail

AppServerInvocationResult

Method Detail

writeExternal

readExternal

isInvalidInHandle

setInvalidInHandle

getProcedureId

setProcedureId

getConnectionID

setConnectionID

setReturnValue

getClientContextId

setClientContextId

getRequestId

setRequestId

getVersionInfo

setVersionInfo

getClientType

setClientType

getAgentId

setAgentId

getSessionId

setSessionId

getThreadId

setThreadId

getClientPrincipal

setClientPrincipal

storeResponse