com.ibm.mq
Class MQPutMessageOptions

java.lang.Object
  |
  +--com.ibm.mq.MQPutMessageOptions

public class MQPutMessageOptions
extends java.lang.Object

This class contains options that control the behavior of MQQueue.put.


Field Summary
 MQQueue contextReference
          An input field that indicates the source of the context information.
 int contextReferenceHandle
          Handle to the context reference
 int invalidDestCount
          Number of messages that could not be sent.
 int knownDestCount
          Number of messages successfully sent to local queues.
 int options
          Options that control the action of MQQueue.put().
 int recordFields
          Flag that controls the behavior of MQPUT when used with distribution lists.
 java.lang.String resolvedQueueManagerName
          An output field set by the queue manager to the name of the queue manager that owns the remote queue.
 java.lang.String resolvedQueueName
          The output field set by the queue manager to the name of the queue on which the message is placed.
 int unknownDestCount
          Number of messages successfully sent to remote queues.
 
Constructor Summary
MQPutMessageOptions()
          Constructs an object with no options set, and blank resolvedQueueName and resolvedQueueManagerName.
MQPutMessageOptions(boolean noReadBack)
          Constructs an MQPutMessageOptions object; reading the options field is optional.
 
Method Summary
 void updateDistributionListItems()
          Copies updates in the response records into the distribution list items.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

options

public int options
Options that control the action of MQQueue.put(). Any or none of the following values can be specified. If more than one option is required, the values can be combined using '+' or '|'.


contextReferenceHandle

public int contextReferenceHandle
Handle to the context reference


contextReference

public MQQueue contextReference
An input field that indicates the source of the context information. If the options field includes MQC.MQPMO_PASS_IDENTITY_CONTEXT or MQC.MQPMO_PASS_ALL_CONTEXT, set this field to refer to the MQQueue from which to take the context information. The initial value of this field is null.


resolvedQueueName

public java.lang.String resolvedQueueName
The output field set by the queue manager to the name of the queue on which the message is placed. This might be different from the name used to open the queue, if the opened queue was an alias or model queue.

See Also:
MQC.MQOO_RESOLVE_LOCAL_Q, MQC.MQPMO_RESOLVE_LOCAL_Q

resolvedQueueManagerName

public java.lang.String resolvedQueueManagerName
An output field set by the queue manager to the name of the queue manager that owns the remote queue. This might be different from the name of the queue manager from which the queue was accessed if the queue is a remote queue.

See Also:
MQC.MQOO_RESOLVE_LOCAL_Q, MQC.MQPMO_RESOLVE_LOCAL_Q

knownDestCount

public int knownDestCount
Number of messages successfully sent to local queues.


unknownDestCount

public int unknownDestCount
Number of messages successfully sent to remote queues.


invalidDestCount

public int invalidDestCount
Number of messages that could not be sent.


recordFields

public int recordFields
Flag that controls the behavior of MQPUT when used with distribution lists.

Constructor Detail

MQPutMessageOptions

public MQPutMessageOptions()
Constructs an object with no options set, and blank resolvedQueueName and resolvedQueueManagerName.


MQPutMessageOptions

public MQPutMessageOptions(boolean noReadBack)
Constructs an MQPutMessageOptions object; reading the options field is optional. You can use this constructor to save some overheads if your application never needs to read back the options field.

Parameters:
noReadBack - if true this disables the reading back the options MQPMO field. This avoids the overhead of converting it.
Method Detail

updateDistributionListItems

public void updateDistributionListItems()
Copies updates in the response records into the distribution list items. Called from the bindings.


(c) Copyright IBM Corp. 2005. All Rights Reserved.