com.ibm.mq.pcf

Interface PCFContent

All Known Implementing Classes:

MQCFGR, PCFMessage

Deprecated.

use PCFContent instead.

public interface PCFContent

Interface representing a list of PCF parameter structures. This is implemented by the PCFMessage and MQCFGR classes, each of which is a container for PCF parameters.

Since:

6.0

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	sccsid Deprecated.

Method Summary

Modifier and Type	Method and Description
void	addFilterParameter(int parameter, int operator, byte[] value) Deprecated. Adds a bytes string filter parameter to the group.
void	addFilterParameter(int parameter, int operator, int value) Deprecated. Adds an integer filter parameter to the group.
void	addFilterParameter(int parameter, int operator, java.lang.String value) Deprecated. Adds a string filter parameter to the group.
void	addParameter(int parameter, byte[] value) Deprecated. Adds a byte array parameter to the group.
void	addParameter(int parameter, int value) Deprecated. Adds an integer parameter to the group.
void	addParameter(int parameter, int[] values) Deprecated. Adds an integer list parameter to the group.
void	addParameter(int parameter, long value) Deprecated. Adds a 64-bit integer parameter to the group.
void	addParameter(int parameter, long[] values) Deprecated. Adds a 64-bit integer list parameter to the group.
void	addParameter(int parameter, java.lang.String value) Deprecated. Adds a string parameter to the group.
void	addParameter(int parameter, java.lang.String[] values) Deprecated. Adds a string list parameter to the group.
void	addParameter(PCFParameter parameter) Deprecated. Adds a PCFParameter to the group.
byte[]	getBytesParameterValue(int parameter) Deprecated. Returns the value of the specified byte array parameter (MQCFBS).
long	getInt64ParameterValue(int parameter) Deprecated. Returns the value of the specified integer parameter (MQCFIN64) as an integer.
long[]	getIntList64ParameterValue(int parameter) Deprecated. Returns the value of the specified integer list parameter (MQCFIL64) as an array of integers.
int[]	getIntListParameterValue(int parameter) Deprecated. Returns the value of the specified integer list parameter (MQCFIL) as an array of integers.
int	getIntParameterValue(int parameter) Deprecated. Returns the value of the specified integer parameter (MQCFIN) as an integer.
PCFParameter	getParameter(int parameter) Deprecated. Returns the PCFParameter structure for the specified parameter, or null if the parameter is not found.
int	getParameterCount() Deprecated. Returns the number of parameter structures in the group.
java.util.Enumeration	getParameters() Deprecated. Returns an enumeration of the parameters in the group.
java.lang.Object	getParameterValue(int parameter) Deprecated. Returns the value of the specified parameter, or null if the parameter is not found.
java.lang.String[]	getStringListParameterValue(int parameter) Deprecated. Returns the value of the specified string list parameter (MQCFSL) as an array of strings.
java.lang.String	getStringParameterValue(int parameter) Deprecated. Returns the value of the specified string parameter (MQCFST) as a string.

Field Detail

sccsid

static final java.lang.String sccsid

Deprecated.

See Also:

Constant Field Values

exclude

Method Detail

addParameter

void addParameter(PCFParameter parameter)

Deprecated.

Adds a PCFParameter to the group.

Parameters:

parameter - the parameter structure to add (MQCFIN, MQCFIL, MQCFST and so on)

addParameter

void addParameter(int parameter,
                  int value)

Deprecated.

Adds an integer parameter to the group.

Parameters:

parameter - the integer parameter identifier

value - the integer value

addParameter

void addParameter(int parameter,
                  int[] values)

Deprecated.

Adds an integer list parameter to the group.

Parameters:

parameter - the integer list parameter identifier

values - the array of integer values

addParameter

void addParameter(int parameter,
                  long value)

Deprecated.

Adds a 64-bit integer parameter to the group.

Parameters:

parameter - the integer parameter identifier

value - the integer value

addParameter

void addParameter(int parameter,
                  long[] values)

Deprecated.

Adds a 64-bit integer list parameter to the group.

Parameters:

parameter - the integer list parameter identifier

values - the array of integer values

addParameter

void addParameter(int parameter,
                  java.lang.String value)

Deprecated.

Adds a string parameter to the group.

Parameters:

parameter - the string parameter identifier

value - the string value

addParameter

void addParameter(int parameter,
                  java.lang.String[] values)

Deprecated.

Adds a string list parameter to the group.

Parameters:

parameter - the string list parameter identifier

values - the array of string values

addParameter

void addParameter(int parameter,
                  byte[] value)

Deprecated.

Adds a byte array parameter to the group.

Parameters:

parameter - the string list parameter identifier

value - the array of string values

addFilterParameter

void addFilterParameter(int parameter,
                        int operator,
                        int value)

Deprecated.

Adds an integer filter parameter to the group.

Parameters:

parameter - the filter parameter identifier

operator - one of the MQCFOP_* filter operator constants

value - the filter value

addFilterParameter

void addFilterParameter(int parameter,
                        int operator,
                        java.lang.String value)

Deprecated.

Adds a string filter parameter to the group.

Parameters:

parameter - the filter parameter identifier

operator - one of the MQCFOP_* filter operator constants

value - the filter value

addFilterParameter

void addFilterParameter(int parameter,
                        int operator,
                        byte[] value)

Deprecated.

Adds a bytes string filter parameter to the group.

Parameters:

parameter - the filter parameter identifier

operator - one of the MQCFOP_* filter operator constants

value - the filter value

getParameterCount

int getParameterCount()

Deprecated.

Returns the number of parameter structures in the group.

Returns:

the value of the parameterCount field from the MQCFH

getParameters

java.util.Enumeration getParameters()

Deprecated.

Returns an enumeration of the parameters in the group. The elements of the Enumeration returned are individual PCFParameter instances (instances of MQCFIN, MQCFIL, MQCFST or MQCFSL etc.).

Returns:

the PCF message parameter structures

getParameter

PCFParameter getParameter(int parameter)

Deprecated.

Returns the PCFParameter structure for the specified parameter, or null if the parameter is not found.

Parameters:

parameter -

Returns:

the specified parameter object

getParameterValue

java.lang.Object getParameterValue(int parameter)

Deprecated.

Returns the value of the specified parameter, or null if the parameter is not found. The object returned is a single Integer, a single String, an array of integers or array of Strings depending on the type of PCFParameter. The caller can infer the expected return type from the supplied parameter identifier.

Parameters:

parameter -

Returns:

the specified parameter value

getIntParameterValue

int getIntParameterValue(int parameter)
                  throws PCFException

Deprecated.

Returns the value of the specified integer parameter (MQCFIN) as an integer.

Parameters:

parameter - the integer parameter identifier

Returns:

the integer parameter value

Throws:

PCFException - if the specified parameter does not exist in the message (the reason code given is MQRCCF_CFIN_PARM_ID_ERROR)

getIntListParameterValue

int[] getIntListParameterValue(int parameter)
                        throws PCFException

Deprecated.

Returns the value of the specified integer list parameter (MQCFIL) as an array of integers.

Parameters:

parameter - the integer list parameter identifier

Returns:

the integer list parameter values

Throws:

PCFException - if the specified parameter does not exist in the group (the reason code given is MQRCCF_CFIL_PARM_ID_ERROR)

getInt64ParameterValue

long getInt64ParameterValue(int parameter)
                     throws PCFException

Deprecated.

Returns the value of the specified integer parameter (MQCFIN64) as an integer.

Parameters:

parameter - the integer parameter identifier

Returns:

the integer parameter value

Throws:

PCFException - if the specified parameter does not exist in the message (the reason code given is MQRCCF_CFIN_PARM_ID_ERROR)

getIntList64ParameterValue

long[] getIntList64ParameterValue(int parameter)
                           throws PCFException

Deprecated.

Returns the value of the specified integer list parameter (MQCFIL64) as an array of integers.

Parameters:

parameter - the integer list parameter identifier

Returns:

the integer list parameter values

Throws:

PCFException - if the specified parameter does not exist in the group (the reason code given is MQRCCF_CFIL_PARM_ID_ERROR)

getStringParameterValue

java.lang.String getStringParameterValue(int parameter)
                                  throws PCFException

Deprecated.

Returns the value of the specified string parameter (MQCFST) as a string.

Parameters:

parameter - the string parameter identifier

Returns:

the string parameter value

Throws:

PCFException - if the specified parameter does not exist in the group (the reason code given is MQRCCF_CFST_PARM_ID_ERROR)

getStringListParameterValue

java.lang.String[] getStringListParameterValue(int parameter)
                                        throws PCFException

Deprecated.

Returns the value of the specified string list parameter (MQCFSL) as an array of strings.

Parameters:

parameter - the string list parameter identifier

Returns:

the string list parameter values

Throws:

PCFException - if the specified parameter does not exist in the group (the reason code given is MQRCCF_CFSL_PARM_ID_ERROR; no more specific error code is defined)

getBytesParameterValue

byte[] getBytesParameterValue(int parameter)
                       throws PCFException

Deprecated.

Returns the value of the specified byte array parameter (MQCFBS).

Parameters:

parameter - the byte array parameter identifier

Returns:

the byte array parameter value

Throws:

PCFException - if the specified parameter does not exist in the group (the reason code given is MQRCCF_CFBS_PARM_ID_ERROR)