GetListEntries

java.lang.Object
- com.ibm.jtopenlite.command.program.openlist.GetListEntries

All Implemented Interfaces:

Program, OpenListProgram<ListEntryFormat,ListFormatListener>
```
public class GetListEntries
extends java.lang.Object
implements OpenListProgram<ListEntryFormat,ListFormatListener>
```
Get list entries using the System API: QGYGTLE

Constructor Summary

Constructors
Constructor and Description
`GetListEntries()`
`GetListEntries(int lengthOfReceiverVariable, byte[] requestHandle, int recordLength, int numberOfRecordsToReturn, int startingRecord, ListEntryFormat formatter, ListFormatListener listener)`

Method Summary

Methods
Modifier and Type	Method and Description
`ListFormatListener`	`getFormatListener()` The format listener gets called by the formatter once the output data has been formatted.
`ListEntryFormat`	`getFormatter()` The formatter is the class that handles formatting the output data for each entry in the list.
`int`	`getLengthOfReceiverVariable()`
`ListInformation`	`getListInformation()`
`int`	`getNumberOfParameters()` Returns the number of parameters for this program.
`int`	`getNumberOfRecordsToReturn()`
`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`	`getRecordLength()`
`byte[]`	`getRequestHandle()`
`int`	`getStartingRecord()`
`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`	`setFormatListener(ListFormatListener listener)`
`void`	`setFormatter(ListEntryFormat formatter)`
`void`	`setLengthOfReceiverVariable(int length)`
`void`	`setNumberOfRecordsToReturn(int numberOfRecordsToReturn)`
`void`	`setParameterOutputData(int parmIndex, byte[] tempData, int maxLength)` Sets the output data for the parameter at the specified index.
`void`	`setRecordLength(int recordLength)`
`void`	`setRequestHandle(byte[] requestHandle)`
`void`	`setStartingRecord(int startingRecord)`

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

- Constructor Detail
  - GetListEntries
```
public GetListEntries()
```
  - GetListEntries
```
public GetListEntries(int lengthOfReceiverVariable,
              byte[] requestHandle,
              int recordLength,
              int numberOfRecordsToReturn,
              int startingRecord,
              ListEntryFormat formatter,
              ListFormatListener listener)
```
- Method Detail
  - 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
  - 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
  - getFormatter
```
public ListEntryFormat getFormatter()
```
    Description copied from interface: OpenListProgram
    
    The formatter is the class that handles formatting the output data for each entry in the list.
    
    Specified by:
    
    getFormatter in interface OpenListProgram<ListEntryFormat,ListFormatListener>
  - setFormatter
```
public void setFormatter(ListEntryFormat formatter)
```
    Specified by:
    
    setFormatter in interface OpenListProgram<ListEntryFormat,ListFormatListener>
  - getFormatListener
```
public ListFormatListener getFormatListener()
```
    Description copied from interface: OpenListProgram
    
    The format listener gets called by the formatter once the output data has been formatted.
    
    Specified by:
    
    getFormatListener in interface OpenListProgram<ListEntryFormat,ListFormatListener>
  - setFormatListener
```
public void setFormatListener(ListFormatListener listener)
```
    Specified by:
    
    setFormatListener in interface OpenListProgram<ListEntryFormat,ListFormatListener>
  - getLengthOfReceiverVariable
```
public int getLengthOfReceiverVariable()
```
  - setLengthOfReceiverVariable
```
public void setLengthOfReceiverVariable(int length)
```
  - getListInformation
```
public ListInformation getListInformation()
```
    Specified by:
    
    getListInformation in interface OpenListProgram<ListEntryFormat,ListFormatListener>
  - getRequestHandle
```
public byte[] getRequestHandle()
```
  - setRequestHandle
```
public void setRequestHandle(byte[] requestHandle)
```
  - getRecordLength
```
public int getRecordLength()
```
  - setRecordLength
```
public void setRecordLength(int recordLength)
```
  - getNumberOfRecordsToReturn
```
public int getNumberOfRecordsToReturn()
```
  - setNumberOfRecordsToReturn
```
public void setNumberOfRecordsToReturn(int numberOfRecordsToReturn)
```
  - getStartingRecord
```
public int getStartingRecord()
```
  - setStartingRecord
```
public void setStartingRecord(int startingRecord)
```
  - 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
  - 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
  - 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

GetListEntries

GetListEntries

getProgramName

getProgramLibrary

getNumberOfParameters

newCall

getFormatter

setFormatter

getFormatListener

setFormatListener

getLengthOfReceiverVariable

setLengthOfReceiverVariable

getListInformation

getRequestHandle

setRequestHandle

getRecordLength

setRecordLength

getNumberOfRecordsToReturn

setNumberOfRecordsToReturn

getStartingRecord

setStartingRecord

getParameterInputLength

getParameterOutputLength

getParameterType

getTempDataBuffer

getParameterInputData

setParameterOutputData