com.ibm.jtopenlite.command.program.message
Class OpenListOfMessages

java.lang.Object
  com.ibm.jtopenlite.command.program.message.OpenListOfMessages

All Implemented Interfaces:

Program, OpenListProgram<OpenListOfMessagesLSTM0100,OpenListOfMessagesLSTM0100Listener>

public class OpenListOfMessages
extends Object
implements OpenListProgram<OpenListOfMessagesLSTM0100,OpenListOfMessagesLSTM0100Listener>

QGYOLMSG This class fully implements the V5R4 specification of QGYOLMSG.

Constructor Summary

OpenListOfMessages()

OpenListOfMessages(int lengthOfReceiverVariable, int numberOfRecordsToReturn, String sortInformation, String userOrQueueIndicator, String userOrQueueName, String queueLibrary, OpenListOfMessagesLSTM0100 format)

Method Summary

OpenListOfMessagesLSTM0100Listener	getFormatListener() The format listener gets called by the formatter once the output data has been formatted.
OpenListOfMessagesLSTM0100	getFormatter() The formatter is the class that handles formatting the output data for each entry in the list.
int	getLengthOfReceiverVariable()
ListInformation	getListInformation()
String	getMessageQueue1()
String	getMessageQueue2()
int	getNumberOfParameters() Returns the number of parameters for this program.
int	getNumberOfQueuesUsed()
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.
String	getProgramLibrary() Returns the library of the program object.
String	getProgramName() Returns the name of the program object.
String	getQueueLibrary()
OpenListOfMessagesSelectionListener	getSelectionListener()
String	getSortInformation()
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.
String	getUserOrQueueIndicator()
String	getUserOrQueueName()
void	newCall() Invoked before any other methods on this interface by CommandConnection whenever this Program is called.
void	setFormatListener(OpenListOfMessagesLSTM0100Listener listener)
void	setFormatter(OpenListOfMessagesLSTM0100 format)
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	setQueueLibrary(String s)
void	setSelectionListener(OpenListOfMessagesSelectionListener listener)
void	setSortInformation(String s)
void	setUserOrQueueIndicator(String s)
void	setUserOrQueueName(String s)

Methods inherited from class java.lang.Object

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

Constructor Detail

OpenListOfMessages

public OpenListOfMessages()

OpenListOfMessages

public OpenListOfMessages(int lengthOfReceiverVariable,
                          int numberOfRecordsToReturn,
                          String sortInformation,
                          String userOrQueueIndicator,
                          String userOrQueueName,
                          String queueLibrary,
                          OpenListOfMessagesLSTM0100 format)

Method Detail

getFormatListener

public OpenListOfMessagesLSTM0100Listener 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<OpenListOfMessagesLSTM0100,OpenListOfMessagesLSTM0100Listener>

setFormatListener

public void setFormatListener(OpenListOfMessagesLSTM0100Listener listener)

Specified by:

setFormatListener in interface OpenListProgram<OpenListOfMessagesLSTM0100,OpenListOfMessagesLSTM0100Listener>

getProgramName

public String getProgramName()

Description copied from interface: Program

Returns the name of the program object.

Specified by:

getProgramName in interface Program

getProgramLibrary

public 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

getSelectionListener

public OpenListOfMessagesSelectionListener getSelectionListener()

setSelectionListener

public void setSelectionListener(OpenListOfMessagesSelectionListener listener)

getFormatter

public OpenListOfMessagesLSTM0100 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<OpenListOfMessagesLSTM0100,OpenListOfMessagesLSTM0100Listener>

setFormatter

public void setFormatter(OpenListOfMessagesLSTM0100 format)

Specified by:

setFormatter in interface OpenListProgram<OpenListOfMessagesLSTM0100,OpenListOfMessagesLSTM0100Listener>

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

getListInformation

public ListInformation getListInformation()

Specified by:

getListInformation in interface OpenListProgram<OpenListOfMessagesLSTM0100,OpenListOfMessagesLSTM0100Listener>

getLengthOfReceiverVariable

public int getLengthOfReceiverVariable()

setLengthOfReceiverVariable

public void setLengthOfReceiverVariable(int length)

getNumberOfRecordsToReturn

public int getNumberOfRecordsToReturn()

setNumberOfRecordsToReturn

public void setNumberOfRecordsToReturn(int numberOfRecordsToReturn)

getSortInformation

public String getSortInformation()

setSortInformation

public void setSortInformation(String s)

getUserOrQueueIndicator

public String getUserOrQueueIndicator()

setUserOrQueueIndicator

public void setUserOrQueueIndicator(String s)

getUserOrQueueName

public String getUserOrQueueName()

setUserOrQueueName

public void setUserOrQueueName(String s)

getQueueLibrary

public String getQueueLibrary()

setQueueLibrary

public void setQueueLibrary(String s)

getNumberOfQueuesUsed

public int getNumberOfQueuesUsed()

getMessageQueue1

public String getMessageQueue1()

getMessageQueue2

public String getMessageQueue2()

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[] data,
                                   int maxLength)

Description copied from interface: Program

Sets the output data for the parameter at the specified index.

Specified by:

setParameterOutputData in interface Program