com.ibm.mq.constants

Interface CMQBC

  • All Known Implementing Classes:
    MQConstants


    public interface CMQBC
    The CMQC interface defines constants used with the MQ Administration Interface.

    To refer to one of these constants from within your programs, simply prefix constant name with "CMQBC.".

    A full description of these constants can be found in the WebSphere MQ Application Programming Reference.

    • Field Detail

      • MQCBO_NONE

        static final int MQCBO_NONE
        Specifies that all options should have their default values. This is provided to aid program documentation, and must not be specified with any of the options that has a nonzero value.
        See Also:
        Constant Field Values
      • MQCBO_USER_BAG

        static final int MQCBO_USER_BAG
        Specifies that the bag is a user bag.

        This is the default bag-type option.

        See Also:
        Constant Field Values
      • MQCBO_ADMIN_BAG

        static final int MQCBO_ADMIN_BAG
        Specifies that the bag is for administering WebSphere MQ objects.

        MQCBO_ADMIN_BAG automatically implies the MQCBO_LIST_FORM_ALLOWED,MQCBO_REORDER_AS_REQUIRED, and MQCBO_CHECK_SELECTORS options.

        See Also:
        Constant Field Values
      • MQCBO_COMMAND_BAG

        static final int MQCBO_COMMAND_BAG
        Specifies that the bag is a command bag.

        This is an alternative to the administration bag (MQCBO_ADMIN_BAG) and MQRC_OPTIONS_ERROR results if both are specified.

        See Also:
        Constant Field Values
      • MQCBO_SYSTEM_BAG

        static final int MQCBO_SYSTEM_BAG
        Specifies that the bag is a System bag.
        See Also:
        Constant Field Values
      • MQCBO_GROUP_BAG

        static final int MQCBO_GROUP_BAG
        Specifies that the bag is a group bag.

        This means that the bag is used to hold a set of grouped items. Group bags cannot be used for the administration of WebSphere MQ objects.

        The bag options assume the following default values:

        • MQCBO_LIST_FORM_ALLOWED
        • MQCBO_REORDER_AS_REQUIRED
        • MQCBO_DO_NOT_CHECK_SELECTORS
        See Also:
        Constant Field Values
      • MQCBO_LIST_FORM_ALLOWED

        static final int MQCBO_LIST_FORM_ALLOWED
        Specifies that the MQAI is allowed to use the more compact list form in the message sent whenever there are two or more adjacent occurrences of the same selector in the bag.
        See Also:
        Constant Field Values
      • MQCBO_LIST_FORM_INHIBITED

        static final int MQCBO_LIST_FORM_INHIBITED
        Specifies that the MQAI is not allowed to use the list form in the message sent, even if there are adjacent occurrences of the same selector in the bag.

        This is the default list-form option.

        See Also:
        Constant Field Values
      • MQCBO_REORDER_AS_REQUIRED

        static final int MQCBO_REORDER_AS_REQUIRED
        Specifies that the MQAI is allowed to change the order of the data items in the message sent.
        See Also:
        Constant Field Values
      • MQCBO_DO_NOT_REORDER

        static final int MQCBO_DO_NOT_REORDER
        Specifies that the MQAI is not allowed to change the order of the data items in the message sent.

        This is the default ordering option.

        See Also:
        Constant Field Values
      • MQCBO_CHECK_SELECTORS

        static final int MQCBO_CHECK_SELECTORS
        Specifies that user selectors (selectors that are zero or greater) should be checked to ensure that the selector is consistent with the datatype implied
        See Also:
        Constant Field Values
      • MQCBO_DO_NOT_CHECK_SELECTORS

        static final int MQCBO_DO_NOT_CHECK_SELECTORS
        Specifies that user selectors (selectors that are zero or greater) are not to be checked.

        This is the default selectors option.

        See Also:
        Constant Field Values
      • MQBL_NULL_TERMINATED

        static final int MQBL_NULL_TERMINATED
        Buffer Length for mqAddString and mqSetString - the string length is indicated by the BufferLength parameter. The value must be zero or greater, or the special value MQBL_NULL_TERMINATED.
        • If MQBL_NULL_TERMINATED is specified, the string is delimited by the first null encountered in the string.
        • If MQBL_NULL_TERMINATED is not specified, BufferLength characters are inserted into the bag, even if null characters are present; the nulls do not delimit the string.
        See Also:
        Constant Field Values
      • MQITEM_BYTE_STRING

        static final int MQITEM_BYTE_STRING
        Byte string item
        See Also:
        Constant Field Values
      • MQITEM_INTEGER_FILTER

        static final int MQITEM_INTEGER_FILTER
        Integer filter item
        See Also:
        Constant Field Values
      • MQITEM_STRING_FILTER

        static final int MQITEM_STRING_FILTER
        String filter item
        See Also:
        Constant Field Values
      • MQITEM_BYTE_STRING_FILTER

        static final int MQITEM_BYTE_STRING_FILTER
        byte string filter item
        See Also:
        Constant Field Values
      • MQHA_FIRST

        static final int MQHA_FIRST
        Lower limit for handle selectors.
        See Also:
        Constant Field Values
      • MQHA_BAG_HANDLE

        static final int MQHA_BAG_HANDLE
        Identifies a bag handle residing within another bag.
        See Also:
        Constant Field Values
      • MQHA_LAST_USED

        static final int MQHA_LAST_USED
        Upper limit for last handle selector allocated.
        See Also:
        Constant Field Values
      • MQOA_FIRST

        static final int MQOA_FIRST
        Lower limit for Selectors for Object Attributes
        See Also:
        Constant Field Values
      • MQOA_LAST

        static final int MQOA_LAST
        Upper limit for Selectors for Object Attributes
        See Also:
        Constant Field Values
      • MQIASY_FIRST

        static final int MQIASY_FIRST
        Upper limit for integer System Selectors (they are negative numbers)
        See Also:
        Constant Field Values
      • MQIASY_CODED_CHAR_SET_ID

        static final int MQIASY_CODED_CHAR_SET_ID
        Character-set identifier for the character data items in the bag
        See Also:
        Constant Field Values
      • MQIASY_COMMAND

        static final int MQIASY_COMMAND
        PCF command identifier.

        Valid values are the MQCMD_* constants.

        For user messages, the value MQCMD_NONE should be used. The initial value is MQCMD_NONE.

        See Also:
        Constant Field Values
      • MQIASY_MSG_SEQ_NUMBER

        static final int MQIASY_MSG_SEQ_NUMBER
        PCF message sequence number
        See Also:
        Constant Field Values
      • MQIASY_CONTROL

        static final int MQIASY_CONTROL
        PCF control options.

        Valid values are the MQCFC_* constants.

        The initial value is MQCFC_LAST.

        See Also:
        Constant Field Values
      • MQIASY_COMP_CODE

        static final int MQIASY_COMP_CODE
        Completion code.

        Valid values are the MQCC_* constants.

        The initial value is MQCC_OK.

        See Also:
        Constant Field Values
      • MQIASY_REASON

        static final int MQIASY_REASON
        Reason code.

        Valid values are the MQRC_* constants.

        The initial value is MQRC_NONE.

        See Also:
        Constant Field Values
      • MQIASY_BAG_OPTIONS

        static final int MQIASY_BAG_OPTIONS
        Bag-creation options.

        A summation of the options used to create the bag.

        See Also:
        Constant Field Values
      • MQIASY_VERSION

        static final int MQIASY_VERSION
        PCF version.

        Valid values are the MQCFH_VERSION_* constants.

        The initial value is MQCFH_VERSION_1.

        See Also:
        Constant Field Values
      • MQIASY_LAST_USED

        static final int MQIASY_LAST_USED
        Lowest integer System Selector currently in use
        See Also:
        Constant Field Values
      • MQIASY_LAST

        static final int MQIASY_LAST
        Lower limit for integer System Selectors
        See Also:
        Constant Field Values
      • MQSEL_ANY_SELECTOR

        static final int MQSEL_ANY_SELECTOR
        The item to be inquired about is a user or system item
        See Also:
        Constant Field Values
      • MQSEL_ANY_USER_SELECTOR

        static final int MQSEL_ANY_USER_SELECTOR
        The item to be inquired about is a user item
        See Also:
        Constant Field Values
      • MQSEL_ANY_SYSTEM_SELECTOR

        static final int MQSEL_ANY_SYSTEM_SELECTOR
        The item to be inquired about is a system item
        See Also:
        Constant Field Values
      • MQSEL_ALL_SELECTORS

        static final int MQSEL_ALL_SELECTORS
        All user and system items are to be counted.
        See Also:
        Constant Field Values
      • MQSEL_ALL_USER_SELECTORS

        static final int MQSEL_ALL_USER_SELECTORS
        All user items are to be counted; system items are excluded from the count.
        See Also:
        Constant Field Values
      • MQSEL_ALL_SYSTEM_SELECTORS

        static final int MQSEL_ALL_SYSTEM_SELECTORS
        All system items are to be counted; user items are excluded from the count.
        See Also:
        Constant Field Values
      • MQIND_NONE

        static final int MQIND_NONE
        This specifies that there must be one occurrence only of the selector in the bag
        See Also:
        Constant Field Values
      • MQIND_ALL

        static final int MQIND_ALL
        This specifies that all existing occurrences of the specified selector (if any) are to be processed
        See Also:
        Constant Field Values
(c) Copyright IBM Corp. 2008, 2015. All Rights Reserved.