CallServiceProgramProcedure

java.lang.Object
- com.ibm.jtopenlite.command.program.CallServiceProgramProcedure

All Implemented Interfaces:

Program

Direct Known Subclasses:

RetrieveJournalEntries, RetrieveJournalReceiverInformation
```
public class CallServiceProgramProcedure
extends java.lang.Object
implements Program
```
Service program call - QZRUCLSP This class fully implements the V5R4 specification of QZRUCLSP. This API supports up to seven parameters.
This is designed so that classes to call a service program procedure can be created by extending this class. For examples, see the Direct Known Subclasses information in the javadoc.
A class that extends this class must implement the following methods corresponding to CallServiceProgramParameterFormat.
- void fillInputData(int index, byte[] dataBuffer, int offset)
- int getParameterCount()
- int getParameterFormat(int index)
- int getParameterLength(int index)
- void setOutputData(int index, byte[] dataBuffer, int offset)
See Also:
CallServiceProgramParameterFormat

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`RETURN_VALUE_FORMAT_INTEGER`
`static int`	`RETURN_VALUE_FORMAT_INTEGER_AND_ERROR_NUMBER`
`static int`	`RETURN_VALUE_FORMAT_NONE`
`static int`	`RETURN_VALUE_FORMAT_POINTER`

Constructor Summary

Constructors
Constructor and Description
`CallServiceProgramProcedure()`
`CallServiceProgramProcedure(java.lang.String serviceProgramName, java.lang.String serviceProgramLibrary, java.lang.String exportName, int returnValueFormat)`

Method Summary

Methods
Modifier and Type	Method and Description
`java.lang.String`	`getExportName()`
`int`	`getNumberOfParameters()` Returns the number of parameters for this program.
`CallServiceProgramParameterFormat`	`getParameterFormat()`
`byte[]`	`getParameterInputData(int parmIndex)` Returns the input data of the parameter at the specified index.
`int`	`getParameterInputLength(int parmIndex)` Returns the input length of the parameter at the specified index.
`int`	`getParameterOutputLength(int parmIndex)` Returns the output length of the parameter at the specified index.
`int`	`getParameterType(int parmIndex)` Returns the type of parameter at the specified index.
`java.lang.String`	`getProgramLibrary()` Returns the library of the program object.
`java.lang.String`	`getProgramName()` Returns the name of the program object.
`int`	`getReturnValueErrorNumber()`
`int`	`getReturnValueFormat()`
`int`	`getReturnValueInteger()`
`byte[]`	`getReturnValuePointer()`
`java.lang.String`	`getServiceProgramLibrary()`
`java.lang.String`	`getServiceProgramName()`
`byte[]`	`getTempDataBuffer()` The implementor can create their own temp byte array for the output parameter size and reuse it each time a call is performed, or for more than one parameter on the same call.
`void`	`newCall()` Invoked before any other methods on this interface by CommandConnection whenever this Program is called.
`void`	`setExportName(java.lang.String name)`
`void`	`setParameterFormat(CallServiceProgramParameterFormat format)`
`void`	`setParameterOutputData(int parmIndex, byte[] tempData, int maxLength)` Sets the output data for the parameter at the specified index.
`void`	`setReturnValueFormat(int retval)`
`void`	`setServiceProgramLibrary(java.lang.String lib)`
`void`	`setServiceProgramName(java.lang.String name)`

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

- Field Detail
  - RETURN_VALUE_FORMAT_NONE
```
public static final int RETURN_VALUE_FORMAT_NONE
```
    See Also:
    Constant Field Values
  - RETURN_VALUE_FORMAT_INTEGER
```
public static final int RETURN_VALUE_FORMAT_INTEGER
```
    See Also:
    Constant Field Values
  - RETURN_VALUE_FORMAT_POINTER
```
public static final int RETURN_VALUE_FORMAT_POINTER
```
    See Also:
    Constant Field Values
  - RETURN_VALUE_FORMAT_INTEGER_AND_ERROR_NUMBER
```
public static final int RETURN_VALUE_FORMAT_INTEGER_AND_ERROR_NUMBER
```
    See Also:
    Constant Field Values
- Constructor Detail
  - CallServiceProgramProcedure
```
public CallServiceProgramProcedure()
```
  - CallServiceProgramProcedure
```
public CallServiceProgramProcedure(java.lang.String serviceProgramName,
                           java.lang.String serviceProgramLibrary,
                           java.lang.String exportName,
                           int returnValueFormat)
```
- Method Detail
  - getServiceProgramName
```
public java.lang.String getServiceProgramName()
```
  - setServiceProgramName
```
public void setServiceProgramName(java.lang.String name)
```
  - getServiceProgramLibrary
```
public java.lang.String getServiceProgramLibrary()
```
  - setServiceProgramLibrary
```
public void setServiceProgramLibrary(java.lang.String lib)
```
  - getExportName
```
public java.lang.String getExportName()
```
  - setExportName
```
public void setExportName(java.lang.String name)
```
  - getReturnValueFormat
```
public int getReturnValueFormat()
```
  - setReturnValueFormat
```
public void setReturnValueFormat(int retval)
```
  - getParameterFormat
```
public CallServiceProgramParameterFormat getParameterFormat()
```
  - setParameterFormat
```
public void setParameterFormat(CallServiceProgramParameterFormat format)
```
  - getProgramName
```
public java.lang.String getProgramName()
```
    Description copied from interface: Program
    
    Returns the name of the program object.
    
    Specified by:
    
    getProgramName in interface Program
  - getProgramLibrary
```
public java.lang.String getProgramLibrary()
```
    Description copied from interface: Program
    
    Returns the library of the program object.
    
    Specified by:
    
    getProgramLibrary in interface Program
  - getNumberOfParameters
```
public int getNumberOfParameters()
```
    Description copied from interface: Program
    
    Returns the number of parameters for this program.
    
    Specified by:
    
    getNumberOfParameters in interface Program
  - getTempDataBuffer
```
public final byte[] getTempDataBuffer()
```
    Description copied from interface: Program
    
    The implementor can create their own temp byte array for the output parameter size and reuse it each time a call is performed, or for more than one parameter on the same call. The implementor can choose to ignore this, and simply return null. The command connection checks to see if the buffer returned by this method is not null and large enough to accommodate the output parameter size.
    
    Specified by:
    
    getTempDataBuffer in interface Program
  - newCall
```
public void newCall()
```
    Description copied from interface: Program
    
    Invoked before any other methods on this interface by CommandConnection whenever this Program is called.
    
    Specified by:
    
    newCall in interface Program
  - getReturnValueInteger
```
public int getReturnValueInteger()
```
  - getReturnValueErrorNumber
```
public int getReturnValueErrorNumber()
```
  - getReturnValuePointer
```
public byte[] getReturnValuePointer()
```
  - getParameterInputLength
```
public int getParameterInputLength(int parmIndex)
```
    Description copied from interface: Program
    
    Returns the input length of the parameter at the specified index.
    
    Specified by:
    
    getParameterInputLength in interface Program
  - getParameterOutputLength
```
public int getParameterOutputLength(int parmIndex)
```
    Description copied from interface: Program
    
    Returns the output length of the parameter at the specified index.
    
    Specified by:
    
    getParameterOutputLength in interface Program
  - getParameterType
```
public int getParameterType(int parmIndex)
```
    Description copied from interface: Program
    
    Returns the type of parameter at the specified index.
    
    Specified by:
    
    getParameterType in interface Program
    
    See Also:
    Parameter
  - getParameterInputData
```
public byte[] getParameterInputData(int parmIndex)
```
    Description copied from interface: Program
    
    Returns the input data of the parameter at the specified index.
    
    Specified by:
    
    getParameterInputData in interface Program
  - setParameterOutputData
```
public void setParameterOutputData(int parmIndex,
                          byte[] tempData,
                          int maxLength)
```
    Description copied from interface: Program
    
    Sets the output data for the parameter at the specified index.
    
    Specified by:
    
    setParameterOutputData in interface Program

Methods inherited from class java.lang.Object

RETURN_VALUE_FORMAT_NONE

RETURN_VALUE_FORMAT_INTEGER

RETURN_VALUE_FORMAT_POINTER

RETURN_VALUE_FORMAT_INTEGER_AND_ERROR_NUMBER

CallServiceProgramProcedure

CallServiceProgramProcedure

getServiceProgramName

setServiceProgramName

getServiceProgramLibrary

setServiceProgramLibrary

getExportName

setExportName

getReturnValueFormat

setReturnValueFormat

getParameterFormat

setParameterFormat

getProgramName

getProgramLibrary

getNumberOfParameters

getTempDataBuffer

newCall

getReturnValueInteger

getReturnValueErrorNumber

getReturnValuePointer

getParameterInputLength

getParameterOutputLength

getParameterType

getParameterInputData

setParameterOutputData