com.ibm.jtopenlite.command.program.journal

Class RetrieveJournalReceiverInformation

java.lang.Object

com.ibm.jtopenlite.command.program.CallServiceProgramProcedure

com.ibm.jtopenlite.command.program.journal.RetrieveJournalReceiverInformation

All Implemented Interfaces:

Program, CallServiceProgramParameterFormat

public class RetrieveJournalReceiverInformation
extends CallServiceProgramProcedure
implements CallServiceProgramParameterFormat

QJOURNAL.QjoRtvJrnReceiverInformation

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	FORMAT_RRCV0100

Fields inherited from class com.ibm.jtopenlite.command.program.CallServiceProgramProcedure

RETURN_VALUE_FORMAT_INTEGER, RETURN_VALUE_FORMAT_INTEGER_AND_ERROR_NUMBER, RETURN_VALUE_FORMAT_NONE, RETURN_VALUE_FORMAT_POINTER

Fields inherited from interface com.ibm.jtopenlite.command.program.CallServiceProgramParameterFormat

PARAMETER_FORMAT_BY_REFERENCE, PARAMETER_FORMAT_BY_VALUE

Constructor Summary

Constructors

Constructor and Description
RetrieveJournalReceiverInformation()
RetrieveJournalReceiverInformation(int lengthOfReceiverVariable, java.lang.String receiverName, java.lang.String receiverLibrary, java.lang.String format, RetrieveJournalReceiverInformationListener listener)
RetrieveJournalReceiverInformation(java.lang.String receiverName, java.lang.String receiverLibrary, RetrieveJournalReceiverInformationListener listener)

Method Summary

Methods

Modifier and Type	Method and Description
void	fillInputData(int parmIndex, byte[] buffer, int offset) This method is used to fill an output buffer with the parameter information before the procedure is called.
java.lang.String	getFormatName()
int	getLengthOfReceiverVariable()
RetrieveJournalReceiverInformationListener	getListener()
int	getParameterCount() This method is called to get the number of parameters used by the service program procedure call.
int	getParameterFormat(int parmIndex) This method is used to obtain the format of the specified parameter
int	getParameterLength(int parmIndex) This method is used to obtain the length of the specified parameter
java.lang.String	getReceiverLibrary()
java.lang.String	getReceiverName()
void	setFormatName(java.lang.String format)
void	setLengthOfReceiverVariable(int length)
void	setListener(RetrieveJournalReceiverInformationListener listener)
void	setOutputData(int parmIndex, byte[] buffer, int offset) This method is used to set the internal value of the parameter from a dataBuffer
void	setReceiverLibrary(java.lang.String lib)
void	setReceiverName(java.lang.String name)

Methods inherited from class com.ibm.jtopenlite.command.program.CallServiceProgramProcedure

getExportName, getNumberOfParameters, getParameterFormat, getParameterInputData, getParameterInputLength, getParameterOutputLength, getParameterType, getProgramLibrary, getProgramName, getReturnValueErrorNumber, getReturnValueFormat, getReturnValueInteger, getReturnValuePointer, getServiceProgramLibrary, getServiceProgramName, getTempDataBuffer, newCall, setExportName, setParameterFormat, setParameterOutputData, setReturnValueFormat, setServiceProgramLibrary, setServiceProgramName

Methods inherited from class java.lang.Object

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

Field Detail

FORMAT_RRCV0100

public static final java.lang.String FORMAT_RRCV0100

See Also:

Constant Field Values

Constructor Detail

RetrieveJournalReceiverInformation

public RetrieveJournalReceiverInformation()

RetrieveJournalReceiverInformation

public RetrieveJournalReceiverInformation(java.lang.String receiverName,
                                  java.lang.String receiverLibrary,
                                  RetrieveJournalReceiverInformationListener listener)

RetrieveJournalReceiverInformation

public RetrieveJournalReceiverInformation(int lengthOfReceiverVariable,
                                  java.lang.String receiverName,
                                  java.lang.String receiverLibrary,
                                  java.lang.String format,
                                  RetrieveJournalReceiverInformationListener listener)

Method Detail

getParameterCount

public int getParameterCount()

Description copied from interface: CallServiceProgramParameterFormat

This method is called to get the number of parameters used by the service program procedure call.

Specified by:

getParameterCount in interface CallServiceProgramParameterFormat

Returns:

parameterCount

getParameterLength

public int getParameterLength(int parmIndex)

Description copied from interface: CallServiceProgramParameterFormat

This method is used to obtain the length of the specified parameter

Specified by:

getParameterLength in interface CallServiceProgramParameterFormat

Parameters:

parmIndex - 0-based parameter identifier.

Returns:

parameter length

getParameterFormat

public int getParameterFormat(int parmIndex)

Description copied from interface: CallServiceProgramParameterFormat

This method is used to obtain the format of the specified parameter

Specified by:

getParameterFormat in interface CallServiceProgramParameterFormat

Parameters:

parmIndex - 0-based parameter identifier.

Returns:

parameter format which is one of the following: PARAMETER_FORMAT_BY_VALUE PARAMETER_FORMAT_BY_REFERENCE

fillInputData

public void fillInputData(int parmIndex,
                 byte[] buffer,
                 int offset)

Description copied from interface: CallServiceProgramParameterFormat

This method is used to fill an output buffer with the parameter information before the procedure is called.

Specified by:

fillInputData in interface CallServiceProgramParameterFormat

Parameters:

parmIndex - 0-based parameter identifier

buffer - buffer containing the data

offset - offset to where the data should be placed

setOutputData

public void setOutputData(int parmIndex,
                 byte[] buffer,
                 int offset)

Description copied from interface: CallServiceProgramParameterFormat

This method is used to set the internal value of the parameter from a dataBuffer

Specified by:

setOutputData in interface CallServiceProgramParameterFormat

Parameters:

parmIndex - 0-based parameter identifier

buffer - buffer containing the data

offset - offset to where the data should be retrieved

getLengthOfReceiverVariable

public int getLengthOfReceiverVariable()

setLengthOfReceiverVariable

public void setLengthOfReceiverVariable(int length)

getReceiverName

public java.lang.String getReceiverName()

setReceiverName

public void setReceiverName(java.lang.String name)

getReceiverLibrary

public java.lang.String getReceiverLibrary()

setReceiverLibrary

public void setReceiverLibrary(java.lang.String lib)

getFormatName

public java.lang.String getFormatName()

setFormatName

public void setFormatName(java.lang.String format)

getListener

public RetrieveJournalReceiverInformationListener getListener()

setListener

public void setListener(RetrieveJournalReceiverInformationListener listener)