com.ibm.as400.access

Class PxReqCV

java.lang.Object

com.ibm.as400.access.PxReqCV

public abstract class PxReqCV
extends java.lang.Object

The PxReqCV class represents the client portion of a request.

Constructor Summary

Constructors

Constructor and Description
PxReqCV(short type) Constructs a PxReqCV object.
PxReqCV(short type, boolean asynchronous) Constructs a PxReqCV object.

Method Summary

Methods

Modifier and Type	Method and Description
void	addObjectParm(java.lang.Object object)
void	addObjectParm(com.ibm.as400.access.PxTable pxTable, java.lang.Object object)
void	addParm(com.ibm.as400.access.PxParm parameter) Appends a parameter to the datastream.
void	clearParms() Clears the parameters.
java.lang.Object	clone() Returns a new copy of this datastream.
void	dump(java.io.PrintWriter output) Dumps the datastream for debugging and tracing.
long	getCorrelationId()
com.ibm.as400.access.PxParm	getParm(int i) Returns a parameter.
int	getParmCount() Returns the parameter count.
short	getType() Returns the datastream type.
void	readFrom(java.io.InputStream input, com.ibm.as400.access.PxDSFactory factory) Loads this datastream by reading from an input stream.
java.lang.String	toString() Returns the String representation of the datastream.
void	writeTo(java.io.OutputStream output) Writes the contents of the datastream to an output stream.

Methods inherited from class java.lang.Object

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

Constructor Detail

PxReqCV

public PxReqCV(short type)

Constructs a PxReqCV object.

Parameters:

type - The datastream type. Valid values are listed in the ProxyConstants class.

PxReqCV

public PxReqCV(short type,
       boolean asynchronous)

Constructs a PxReqCV object.

Parameters:

type - The datastream type. Valid values are listed in the ProxyConstants class.

asynchronous - true if asynchronous, false otherwise.

Method Detail

dump

public void dump(java.io.PrintWriter output)

Dumps the datastream for debugging and tracing.

Parameters:

output - The print writer.

getCorrelationId

public long getCorrelationId()

writeTo

public void writeTo(java.io.OutputStream output)
             throws java.io.IOException

Writes the contents of the datastream to an output stream.

Parameters:

output - The output stream.

Throws:

java.io.IOException - If an error occurs.

addObjectParm

public void addObjectParm(java.lang.Object object)

addObjectParm

public void addObjectParm(com.ibm.as400.access.PxTable pxTable,
                 java.lang.Object object)

addParm

public void addParm(com.ibm.as400.access.PxParm parameter)

Appends a parameter to the datastream.

Parameters:

parameter - The parameter.

clearParms

public void clearParms()

Clears the parameters.

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Returns a new copy of this datastream.

Returns:

A new copy of this datastream.

Throws:

java.lang.CloneNotSupportedException - If the object cannot be cloned.

getParm

public com.ibm.as400.access.PxParm getParm(int i)

Returns a parameter.

Parameters:

i - The parameter index (0-based).

Returns:

The parameter.

getParmCount

public int getParmCount()

Returns the parameter count.

Returns:

The parameter count.

readFrom

public void readFrom(java.io.InputStream input,
            com.ibm.as400.access.PxDSFactory factory)
              throws java.io.IOException

Loads this datastream by reading from an input stream.

Parameters:

input - The input stream.

factory - The datastream factory. This is sometimes needed when datastreams are nested.

Throws:

java.io.IOException - If an error occurs.

getType

public short getType()

Returns the datastream type.

Returns:

The datastream type.

toString

public java.lang.String toString()

Returns the String representation of the datastream.

Overrides:

toString in class java.lang.Object

Returns:

The String representation of the datastream.