Package com.ibm.mq.pcf
Interface PCFContent
- All Known Implementing Classes:
MQCFGR,PCFMessage
public interface PCFContent
Deprecated.
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 -
Method Summary
Modifier and TypeMethodDescriptionvoidaddFilterParameter(int parameter, int operator, byte[] value) Deprecated.Adds a bytes string filter parameter to the group.voidaddFilterParameter(int parameter, int operator, int value) Deprecated.Adds an integer filter parameter to the group.voidaddFilterParameter(int parameter, int operator, String value) Deprecated.Adds a string filter parameter to the group.voidaddParameter(int parameter, byte[] value) Deprecated.Adds a byte array parameter to the group.voidaddParameter(int parameter, int value) Deprecated.Adds an integer parameter to the group.voidaddParameter(int parameter, int[] values) Deprecated.Adds an integer list parameter to the group.voidaddParameter(int parameter, long value) Deprecated.Adds a 64-bit integer parameter to the group.voidaddParameter(int parameter, long[] values) Deprecated.Adds a 64-bit integer list parameter to the group.voidaddParameter(int parameter, String value) Deprecated.Adds a string parameter to the group.voidaddParameter(int parameter, String[] values) Deprecated.Adds a string list parameter to the group.voidaddParameter(PCFParameter parameter) Deprecated.Adds a PCFParameter to the group.byte[]getBytesParameterValue(int parameter) Deprecated.Returns the value of the specified byte array parameter (MQCFBS).longgetInt64ParameterValue(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.intgetIntParameterValue(int parameter) Deprecated.Returns the value of the specified integer parameter (MQCFIN) as an integer.getParameter(int parameter) Deprecated.Returns the PCFParameter structure for the specified parameter, or null if the parameter is not found.intDeprecated.Returns the number of parameter structures in the group.Deprecated.Returns an enumeration of the parameters in the group.getParameterValue(int parameter) Deprecated.Returns the value of the specified parameter, or null if the parameter is not found.String[]getStringListParameterValue(int parameter) Deprecated.Returns the value of the specified string list parameter (MQCFSL) as an array of strings.getStringParameterValue(int parameter) Deprecated.Returns the value of the specified string parameter (MQCFST) as a string.
-
Field Details
-
sccsid
Deprecated.- See Also:
- exclude
-
-
Method Details
-
addParameter
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 identifiervalue- 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 identifiervalues- 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 identifiervalue- 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 identifiervalues- the array of integer values
-
addParameter
Deprecated.Adds a string parameter to the group.- Parameters:
parameter- the string parameter identifiervalue- the string value
-
addParameter
Deprecated.Adds a string list parameter to the group.- Parameters:
parameter- the string list parameter identifiervalues- 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 identifiervalue- 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 identifieroperator- one of the MQCFOP_* filter operator constantsvalue- the filter value
-
addFilterParameter
Deprecated.Adds a string filter parameter to the group.- Parameters:
parameter- the filter parameter identifieroperator- one of the MQCFOP_* filter operator constantsvalue- 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 identifieroperator- one of the MQCFOP_* filter operator constantsvalue- 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
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
Deprecated.Returns the PCFParameter structure for the specified parameter, or null if the parameter is not found.- Parameters:
parameter- for which the PCF structure to be returned- Returns:
- the specified parameter object
-
getParameterValue
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- for which the value to be returned- Returns:
- the specified parameter value
-
getIntParameterValue
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
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
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
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
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
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
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)
-
PCFContentinstead.