com.ibm.jtopenlite.command.program.print
Class OpenListOfSpooledFiles
- java.lang.Object
-
- com.ibm.jtopenlite.command.program.print.OpenListOfSpooledFiles
-
- All Implemented Interfaces:
- Program, OpenListProgram<OpenListOfSpooledFilesFormat,OpenListOfSpooledFilesFormatListener>
public class OpenListOfSpooledFiles extends java.lang.Object implements OpenListProgram<OpenListOfSpooledFilesFormat,OpenListOfSpooledFilesFormatListener>
QGYOLSPL This class fully implements the V5R4 specification of QGYOLSPL.
-
-
Constructor Summary
Constructors Constructor and Description OpenListOfSpooledFiles()
OpenListOfSpooledFiles(OpenListOfSpooledFilesFormat format, int lengthOfReceiverVariable, int numberOfRecordsToReturn, SortListener sortInformation, OpenListOfSpooledFilesFilterListener filterInformation, java.lang.String jobName, java.lang.String jobUser, java.lang.String jobNumber)
-
Method Summary
Methods Modifier and Type Method and Description OpenListOfSpooledFilesFilterListener
getFilterListener()
OpenListOfSpooledFilesFormatListener
getFormatListener()
The format listener gets called by the formatter once the output data has been formatted.OpenListOfSpooledFilesFormat
getFormatter()
The formatter is the class that handles formatting the output data for each entry in the list.java.lang.String
getJobName()
java.lang.String
getJobNumber()
java.lang.String
getJobUser()
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.SortListener
getSortListener()
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
setFilterListener(OpenListOfSpooledFilesFilterListener listener)
void
setFormatListener(OpenListOfSpooledFilesFormatListener listener)
void
setFormatter(OpenListOfSpooledFilesFormat formatter)
void
setJobName(java.lang.String name)
void
setJobNumber(java.lang.String number)
void
setJobUser(java.lang.String user)
void
setLengthOfReceiverVariable(int length)
void
setNumberOfRecordsToReturn(int numberOfRecordsToReturn)
void
setParameterOutputData(int parmIndex, byte[] data, int maxLength)
Sets the output data for the parameter at the specified index.void
setSortListener(SortListener listener)
-
-
-
Constructor Detail
-
OpenListOfSpooledFiles
public OpenListOfSpooledFiles()
-
OpenListOfSpooledFiles
public OpenListOfSpooledFiles(OpenListOfSpooledFilesFormat format, int lengthOfReceiverVariable, int numberOfRecordsToReturn, SortListener sortInformation, OpenListOfSpooledFilesFilterListener filterInformation, java.lang.String jobName, java.lang.String jobUser, java.lang.String jobNumber)
-
-
Method Detail
-
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 interfaceProgram
-
getFormatter
public OpenListOfSpooledFilesFormat 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 interfaceOpenListProgram<OpenListOfSpooledFilesFormat,OpenListOfSpooledFilesFormatListener>
-
setFormatter
public void setFormatter(OpenListOfSpooledFilesFormat formatter)
- Specified by:
setFormatter
in interfaceOpenListProgram<OpenListOfSpooledFilesFormat,OpenListOfSpooledFilesFormatListener>
-
getFormatListener
public OpenListOfSpooledFilesFormatListener 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 interfaceOpenListProgram<OpenListOfSpooledFilesFormat,OpenListOfSpooledFilesFormatListener>
-
setFormatListener
public void setFormatListener(OpenListOfSpooledFilesFormatListener listener)
- Specified by:
setFormatListener
in interfaceOpenListProgram<OpenListOfSpooledFilesFormat,OpenListOfSpooledFilesFormatListener>
-
getProgramName
public java.lang.String getProgramName()
Description copied from interface:Program
Returns the name of the program object.- Specified by:
getProgramName
in interfaceProgram
-
getProgramLibrary
public java.lang.String getProgramLibrary()
Description copied from interface:Program
Returns the library of the program object.- Specified by:
getProgramLibrary
in interfaceProgram
-
getNumberOfParameters
public int getNumberOfParameters()
Description copied from interface:Program
Returns the number of parameters for this program.- Specified by:
getNumberOfParameters
in interfaceProgram
-
newCall
public void newCall()
Description copied from interface:Program
Invoked before any other methods on this interface by CommandConnection whenever this Program is called.
-
setJobName
public void setJobName(java.lang.String name)
-
getJobName
public java.lang.String getJobName()
-
setJobUser
public void setJobUser(java.lang.String user)
-
getJobUser
public java.lang.String getJobUser()
-
setJobNumber
public void setJobNumber(java.lang.String number)
-
getJobNumber
public java.lang.String getJobNumber()
-
getLengthOfReceiverVariable
public int getLengthOfReceiverVariable()
-
setLengthOfReceiverVariable
public void setLengthOfReceiverVariable(int length)
-
getNumberOfRecordsToReturn
public int getNumberOfRecordsToReturn()
-
setNumberOfRecordsToReturn
public void setNumberOfRecordsToReturn(int numberOfRecordsToReturn)
-
getSortListener
public SortListener getSortListener()
-
setSortListener
public void setSortListener(SortListener listener)
-
getFilterListener
public OpenListOfSpooledFilesFilterListener getFilterListener()
-
setFilterListener
public void setFilterListener(OpenListOfSpooledFilesFilterListener listener)
-
getListInformation
public ListInformation getListInformation()
- Specified by:
getListInformation
in interfaceOpenListProgram<OpenListOfSpooledFilesFormat,OpenListOfSpooledFilesFormatListener>
-
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 interfaceProgram
-
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 interfaceProgram
-
getParameterType
public int getParameterType(int parmIndex)
Description copied from interface:Program
Returns the type of parameter at the specified index.- Specified by:
getParameterType
in interfaceProgram
- 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 interfaceProgram
-
setParameterOutputData
public void setParameterOutputData(int parmIndex, byte[] data, int maxLength)
Description copied from interface:Program
Sets the output data for the parameter at the specified index.- Specified by:
setParameterOutputData
in interfaceProgram
-
-