|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.as400.access.ProgramParameter
The ProgramParameter class is used with ProgramCall and ServiceProgramCall to pass parameter data to an AS/400 program, from an AS/400 program, or both. Input data is passed to an AS/400 program as a byte array with setInputData. Output data is requested from an AS/400 program by specifying the amount of data to return with setOutputDataLength. To get the output data once the AS/400 program has run use getOutputData. These values may also be set on the constructor.
ProgramCall
,
ServiceProgramCall
, Serialized FormField Summary | |
static int |
PASS_BY_REFERENCE
Constant indicating parameter data is passed by reference. |
static int |
PASS_BY_VALUE
Constant indicating parameter data is passed by value. |
Constructor Summary | |
ProgramParameter()
Constructs a ProgramParameter object. |
|
ProgramParameter(byte[] inputData)
Constructs a ProgramParameter object. |
|
ProgramParameter(byte[] inputData,
int outputDataLength)
Constructs ProgramParameter object. |
|
ProgramParameter(int outputDataLength)
Constructs a ProgramParameter object. |
|
ProgramParameter(int parameterType,
byte[] inputData)
Constructs a ProgramParameter object. |
|
ProgramParameter(int parameterType,
byte[] inputData,
int outputDataLength)
Constructs ProgramParameter object. |
|
ProgramParameter(int parameterType,
int outputDataLength)
Constructs a ProgramParameter object. |
Method Summary | |
void |
addPropertyChangeListener(java.beans.PropertyChangeListener listener)
Adds a PropertyChangeListener. |
void |
addVetoableChangeListener(java.beans.VetoableChangeListener listener)
Adds a VetoableChangeListener. |
byte[] |
getInputData()
Returns the parameter data that will be sent to the program. |
byte[] |
getOutputData()
Returns the parameter data that has been received from the program. |
int |
getOutputDataLength()
Returns the output parameter data length. |
int |
getParameterType()
Returns the program parameter type. |
void |
removePropertyChangeListener(java.beans.PropertyChangeListener listener)
Removes this PropertyChangeListener. |
void |
removeVetoableChangeListener(java.beans.VetoableChangeListener listener)
Removes this VetoableChangeListener. |
void |
setInputData(byte[] inputData)
Sets the parameter data that will be sent to the program. |
void |
setOutputDataLength(int outputDataLength)
Sets the output parameter data length. |
void |
setParameterType(int parameterType)
Sets the type of program parameter. |
Methods inherited from class java.lang.Object |
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait |
Field Detail |
public static final int PASS_BY_VALUE
public static final int PASS_BY_REFERENCE
Constructor Detail |
public ProgramParameter()
public ProgramParameter(byte[] inputData)
inputData
- The parameter data to be used as input to the program.public ProgramParameter(int outputDataLength)
outputDataLength
- The amount of data to be returned from the program.public ProgramParameter(byte[] inputData, int outputDataLength)
inputData
- Parameter data passed to the program.outputDataLength
- The amount of data to be returned from the program.public ProgramParameter(int parameterType, byte[] inputData)
parameterType
- The type of parameter.inputData
- The parameter data to be used as input to the program.public ProgramParameter(int parameterType, int outputDataLength)
parameterType
- The type of parameter.outputDataLength
- The amount of data to be returned from the program.public ProgramParameter(int parameterType, byte[] inputData, int outputDataLength)
parameterType
- The type of parameter.inputData
- The parameter data to be used as input to the program.outputDataLength
- The amount of data to be returned from the program.Method Detail |
public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
listener
- The PropertyChangeListener.removePropertyChangeListener(java.beans.PropertyChangeListener)
public void addVetoableChangeListener(java.beans.VetoableChangeListener listener)
listener
- The VetoableChangeListener.removeVetoableChangeListener(java.beans.VetoableChangeListener)
public byte[] getInputData()
public byte[] getOutputData()
public int getOutputDataLength()
public int getParameterType()
public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
listener
- The PropertyChangeListener.addPropertyChangeListener(java.beans.PropertyChangeListener)
public void removeVetoableChangeListener(java.beans.VetoableChangeListener listener)
listener
- The VetoableChangeListener.addVetoableChangeListener(java.beans.VetoableChangeListener)
public void setInputData(byte[] inputData) throws java.beans.PropertyVetoException
inputData
- The parameter data to be used as input to the program.public void setOutputDataLength(int outputDataLength) throws java.beans.PropertyVetoException
outputDataLength
- The amount of data to be returned from the program (number of bytes).public void setParameterType(int parameterType) throws java.beans.PropertyVetoException
parameterType
- The type of the program parameter. The type must be one of the following:
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |