com.ibm.jtopenlite.command.program

Interface CallServiceProgramParameterFormat

All Known Implementing Classes:

RetrieveJournalEntries, RetrieveJournalReceiverInformation

public interface CallServiceProgramParameterFormat

Interface used to utilize the parameters of a service program call. See the implementing subclasses for examples.

Field Summary

Fields

Modifier and Type	Field and Description
static int	PARAMETER_FORMAT_BY_REFERENCE
static int	PARAMETER_FORMAT_BY_VALUE

Method Summary

Methods

Modifier and Type	Method and Description
void	fillInputData(int index, byte[] dataBuffer, int offset) This method is used to fill an output buffer with the parameter information before the procedure is called.
int	getParameterCount() This method is called to get the number of parameters used by the service program procedure call.
int	getParameterFormat(int index) This method is used to obtain the format of the specified parameter
int	getParameterLength(int index) This method is used to obtain the length of the specified parameter
void	setOutputData(int index, byte[] dataBuffer, int offset) This method is used to set the internal value of the parameter from a dataBuffer

Field Detail

PARAMETER_FORMAT_BY_VALUE

static final int PARAMETER_FORMAT_BY_VALUE

See Also:

Constant Field Values

PARAMETER_FORMAT_BY_REFERENCE

static final int PARAMETER_FORMAT_BY_REFERENCE

See Also:

Constant Field Values

Method Detail

getParameterCount

int getParameterCount()

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

Returns:

parameterCount

getParameterLength

int getParameterLength(int index)

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

Parameters:

index - 0-based parameter identifier.

Returns:

parameter length

getParameterFormat

int getParameterFormat(int index)

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

Parameters:

index - 0-based parameter identifier.

Returns:

parameter format which is one of the following: PARAMETER_FORMAT_BY_VALUE PARAMETER_FORMAT_BY_REFERENCE

fillInputData

void fillInputData(int index,
                 byte[] dataBuffer,
                 int offset)

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

Parameters:

index - 0-based parameter identifier

dataBuffer - buffer containing the data

offset - offset to where the data should be placed

setOutputData

void setOutputData(int index,
                 byte[] dataBuffer,
                 int offset)

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

Parameters:

index - 0-based parameter identifier

dataBuffer - buffer containing the data

offset - offset to where the data should be retrieved