Package com.ibm.mq.headers.pcf

Interface PCFContent

All Known Implementing Classes:
MQCFGR, MQEPH, PCFMessage
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

  • Method Summary

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

  • Method Details

    • addParameter

      void addParameter(PCFParameter parameter)
      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)
      Adds an integer parameter to the group.
      Parameters:
      parameter - the integer parameter identifier
      value - the integer value

    • addParameter

      void addParameter(int parameter, int[] values)
      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)
      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)
      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, String value)
      Adds a string parameter to the group.
      Parameters:
      parameter - the string parameter identifier
      value - the string value

    • addParameter

      void addParameter(int parameter, String[] values)
      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)
      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)
      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, String value)
      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)
      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()
      Returns the number of parameter structures in the group.
      Returns:
      the value of the parameterCount field from the MQCFH

    • getParameters

      Enumeration getParameters()
      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)
      Returns the PCFParameter structure for the specified parameter, or null if the parameter is not found.
      Parameters:
      parameter - identifier whose details to be returned.
      Returns:
      the specified parameter object

    • getParameterValue

      Object getParameterValue(int parameter)
      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 - identifier whose details to be returned
      Returns:
      the specified parameter value

    • getIntParameterValue

      int getIntParameterValue(int parameter) throws PCFException
      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
      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
      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
      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

      String getStringParameterValue(int parameter) throws PCFException
      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

      String[] getStringListParameterValue(int parameter) throws PCFException
      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
      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)