com.ibm.etools.sfm.sfpi
Class SFMQSeriesGenerationProperties

java.lang.Object
  extended by com.ibm.etools.sfm.sfpi.SFGenerationProperties
      extended by com.ibm.etools.sfm.sfpi.SFMQSeriesGenerationProperties

public class SFMQSeriesGenerationProperties
extends SFGenerationProperties

SFMQSeriesGenerationProperties is an implementation of SFGenerationProperties that represents the generation properties for an MQ Series operation.


Field Summary
static java.lang.String MQGetAdapterName
          The MQGET adapter name property.
static java.lang.String MQGetTranId
          The MQGET transaction id property.
static java.lang.String MQMaxOutMsgLen
          The MQ maximum output message length property.
static java.lang.String MQMessageType
          The MQ message type property.
static int MQMessageType_Datagram
          The MQ message type value for Datagram.
static int MQMessageType_Reply
          The MQ message type value for Reply.
static int MQMessageType_Request
          The MQ message type value for Request.
static java.lang.String MQPutAdapterName
          The MQPUT adapter name property.
static java.lang.String MQPutReplyQMgr
          The MQPUT reply queue manager property.
static java.lang.String MQPutReplyQueue
          The MQPUT reply queue property.
static java.lang.String MQPutRequestQueue
          The MQPUT request queue property.
static java.lang.String MQPutTranId
          The MQPUT transaction id property.
static java.lang.String MQWaitInterval
          The MQ wait interval property.
 
Fields inherited from class com.ibm.etools.sfm.sfpi.SFGenerationProperties
InvokeType, InvokeType_Channel, InvokeType_COMMAREA, InvokeType_MQSeries, Runtime, Runtime_CSFR31, Runtime_CSFR32
 
Method Summary
 java.lang.String getMQGetAdapterName()
           
 java.lang.String getMQGetTranId()
           
 int getMQMaxOutMsgLen()
           
 int getMQMessageType()
           
 java.lang.String getMQPutAdapterName()
           
 java.lang.String getMQPutReplyQMgr()
           
 java.lang.String getMQPutReplyQueue()
           
 java.lang.String getMQPutRequestQueue()
           
 java.lang.String getMQPutTranId()
           
 int getMQWaitInterval()
           
 void setMQGetAdapterName(java.lang.String adapterName)
          Sets the value of the MQGET adapter name property.
 void setMQGetTranId(java.lang.String tranId)
          Sets the value of the MQGET transaction id property.
 void setMQMaxOutMsgLen(int maxOutMsgLen)
          Sets the value of the MQ maximum output message length property.
 void setMQMessageType(int msgType)
          Sets the value of the MQ message type property.
 void setMQPutAdapterName(java.lang.String adapterName)
          Sets the value of the MQPUT adapter name property.
 void setMQPutReplyQMgr(java.lang.String qMgr)
          Sets the value of the MQPUT reply queue manager property.
 void setMQPutReplyQueue(java.lang.String replyQueue)
          Sets the value of the MQPUT reply queue property.
 void setMQPutRequestQueue(java.lang.String requestQueue)
          Sets the value of the MQPUT request queue property.
 void setMQPutTranId(java.lang.String tranId)
          Sets the value of the MQPUT transaction id property.
 void setMQWaitInterval(int waitInterval)
          Sets the value of the MQ wait interval property (in seconds).
 
Methods inherited from class com.ibm.etools.sfm.sfpi.SFGenerationProperties
getInvokeType, getRuntime, save, setRuntime
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

MQGetAdapterName

public static final java.lang.String MQGetAdapterName
The MQGET adapter name property.

See Also:
Constant Field Values

MQGetTranId

public static final java.lang.String MQGetTranId
The MQGET transaction id property.

See Also:
Constant Field Values

MQPutAdapterName

public static final java.lang.String MQPutAdapterName
The MQPUT adapter name property.

See Also:
Constant Field Values

MQPutTranId

public static final java.lang.String MQPutTranId
The MQPUT transaction id property.

See Also:
Constant Field Values

MQMaxOutMsgLen

public static final java.lang.String MQMaxOutMsgLen
The MQ maximum output message length property.

See Also:
Constant Field Values

MQMessageType

public static final java.lang.String MQMessageType
The MQ message type property.

See Also:
Constant Field Values

MQMessageType_Request

public static final int MQMessageType_Request
The MQ message type value for Request.

See Also:
Constant Field Values

MQMessageType_Reply

public static final int MQMessageType_Reply
The MQ message type value for Reply.

See Also:
Constant Field Values

MQMessageType_Datagram

public static final int MQMessageType_Datagram
The MQ message type value for Datagram.

See Also:
Constant Field Values

MQPutRequestQueue

public static final java.lang.String MQPutRequestQueue
The MQPUT request queue property.

See Also:
Constant Field Values

MQPutReplyQMgr

public static final java.lang.String MQPutReplyQMgr
The MQPUT reply queue manager property.

See Also:
Constant Field Values

MQPutReplyQueue

public static final java.lang.String MQPutReplyQueue
The MQPUT reply queue property.

See Also:
Constant Field Values

MQWaitInterval

public static final java.lang.String MQWaitInterval
The MQ wait interval property.

See Also:
Constant Field Values
Method Detail

getMQGetAdapterName

public java.lang.String getMQGetAdapterName()
Returns:
The value of the MQGET adapter name property.

setMQGetAdapterName

public void setMQGetAdapterName(java.lang.String adapterName)
                         throws SFException
Sets the value of the MQGET adapter name property. For the Service Flow Runtime for CICS 3.1, the given adapter name is truncated to 7 characters and capitalized. For the Service Flow Runtime for CICS 3.2, the given adapter name is truncated to 8 characters and captitalized.

Parameters:
adapterName - The adapter name.
Throws:
SFException - One of the following exceptions may result:
Error Description Severity
WZEF1001E_ARGSERROR Illegal arguments. The adapterName is null. ERROR: The MQGET adapter name was not set successfully.
WZEF1407E_PROPERTYVALIDATIONFAILED Validation of the property value failed. The specified value for the property contains characters that are not valid. ERROR: The MQGET adapter name was not set successfully.

getMQGetTranId

public java.lang.String getMQGetTranId()
Returns:
The value of the MQGET transaction id property.

setMQGetTranId

public void setMQGetTranId(java.lang.String tranId)
                    throws SFException
Sets the value of the MQGET transaction id property. For the Service Flow Runtime for CICS 3.1, the given adapter name is truncated to 3 characters and capitalized. For the Service Flow Runtime for CICS 3.2, the given adapter name is truncated to 4 characters and captitalized.

Parameters:
tranId - The transaction id.
Throws:
SFException - One of the following exceptions may result:
Error Description Severity
WZEF1001E_ARGSERROR Illegal arguments. The tranId is null. ERROR: The MQGET transaction id was not set successfully.
WZEF1407E_PROPERTYVALIDATIONFAILED Validation of the property value failed. The specified value for the property contains characters that are not valid. ERROR: The MQGET transaction id was not set successfully.

getMQPutAdapterName

public java.lang.String getMQPutAdapterName()
Returns:
The value of the MQPUT adapter name property.

setMQPutAdapterName

public void setMQPutAdapterName(java.lang.String adapterName)
                         throws SFException
Sets the value of the MQPUT adapter name property. For the Service Flow Runtime for CICS 3.1, the given adapter name is truncated to 7 characters and capitalized. For the Service Flow Runtime for CICS 3.2, the given adapter name is truncated to 8 characters and captitalized.

Parameters:
adapterName - The adapter name.
Throws:
SFException - One of the following exceptions may result:
Error Description Severity
WZEF1001E_ARGSERROR Illegal arguments. The adapterName is null. ERROR: The MQPUT adapter name was not set successfully.
WZEF1407E_PROPERTYVALIDATIONFAILED Validation of the property value failed. The specified value for the property contains characters that are not valid. ERROR: The MQPUT adapter name was not set successfully.

getMQPutTranId

public java.lang.String getMQPutTranId()
Returns:
The value of the MQPUT transaction id property.

setMQPutTranId

public void setMQPutTranId(java.lang.String tranId)
                    throws SFException
Sets the value of the MQPUT transaction id property. For the Service Flow Runtime for CICS 3.1, the given adapter name is truncated to 3 characters and capitalized. For the Service Flow Runtime for CICS 3.2, the given adapter name is truncated to 4 characters and captitalized.

Parameters:
tranId - The transaction id.
Throws:
SFException - One of the following exceptions may result:
Error Description Severity
WZEF1001E_ARGSERROR Illegal arguments. The tranId is null. ERROR: The MQPUT transaction id was not set successfully.
WZEF1407E_PROPERTYVALIDATIONFAILED Validation of the property value failed. The specified value for the property contains characters that are not valid. ERROR: The MQPUT transaction id was not set successfully.

getMQMaxOutMsgLen

public int getMQMaxOutMsgLen()
Returns:
The value of the MQ maximum output message length property.

setMQMaxOutMsgLen

public void setMQMaxOutMsgLen(int maxOutMsgLen)
                       throws SFException
Sets the value of the MQ maximum output message length property.

Parameters:
maxOutMsgLen - The maximum length.
Throws:
SFException - One of the following exceptions may result:
Error Description Severity
WZEF1001E_ARGSERROR Illegal arguments. The maxOutMsgLen is less than zero. ERROR: The MQ maximum output message length was not set successfully.

getMQMessageType

public int getMQMessageType()
Returns:
The value of the MQ message type property.

setMQMessageType

public void setMQMessageType(int msgType)
                      throws SFException
Sets the value of the MQ message type property.

Parameters:
msgType - The message type.
Throws:
SFException - One of the following exceptions may result:
Error Description Severity
WZEF1001E_ARGSERROR Illegal arguments. The msgType is not one of MQMessageType_Request, MQMessageType_Reply, or MQMessageType_Datagram. ERROR: The MQ message type was not set successfully.

getMQPutRequestQueue

public java.lang.String getMQPutRequestQueue()
Returns:
The value of the MQPUT request queue property.

setMQPutRequestQueue

public void setMQPutRequestQueue(java.lang.String requestQueue)
                          throws SFException
Sets the value of the MQPUT request queue property. The given request queue name is truncated to 48 characters and capitalized.

Parameters:
requestQueue - The request queue.
Throws:
SFException - One of the following exceptions may result:
Error Description Severity
WZEF1001E_ARGSERROR Illegal arguments. The request queue is null. ERROR: The MQPUT request queue was not set successfully.
WZEF1407E_PROPERTYVALIDATIONFAILED Validation of the property value failed. The specified value for the property contains characters that are not valid. ERROR: The MQPUT request queue was not set successfully.

getMQPutReplyQMgr

public java.lang.String getMQPutReplyQMgr()
Returns:
The value of the MQPUT reply queue manager property.

setMQPutReplyQMgr

public void setMQPutReplyQMgr(java.lang.String qMgr)
                       throws SFException
Sets the value of the MQPUT reply queue manager property. The given request queue name is truncated to 48 characters and capitalized.

Parameters:
qMgr - The reply queue manager.
Throws:
SFException - One of the following exceptions may result:
Error Description Severity
WZEF1001E_ARGSERROR Illegal arguments. The qMgr is null. ERROR: The MQPUT reply queue manager was not set successfully.
WZEF1407E_PROPERTYVALIDATIONFAILED Validation of the property value failed. The specified value for the property contains characters that are not valid. ERROR: The MQPUT reply queue manager was not set successfully.

getMQPutReplyQueue

public java.lang.String getMQPutReplyQueue()
Returns:
The value of the MQPUT reply queue property.

setMQPutReplyQueue

public void setMQPutReplyQueue(java.lang.String replyQueue)
                        throws SFException
Sets the value of the MQPUT reply queue property. The given request queue name is truncated to 48 characters and capitalized.

Parameters:
replyQueue - The reply queue manager.
Throws:
SFException - One of the following exceptions may result:
Error Description Severity
WZEF1001E_ARGSERROR Illegal arguments. The replyQueue is null. ERROR: The MQPUT reply queue was not set successfully.
WZEF1407E_PROPERTYVALIDATIONFAILED Validation of the property value failed. The specified value for the property contains characters that are not valid. ERROR: The MQPUT reply queue was not set successfully.

getMQWaitInterval

public int getMQWaitInterval()
Returns:
The value of the MQ wait interval property.

setMQWaitInterval

public void setMQWaitInterval(int waitInterval)
                       throws SFException
Sets the value of the MQ wait interval property (in seconds).

Parameters:
waitInterval - The wait interval.
Throws:
SFException - One of the following exceptions may result:
Error Description Severity
WZEF1001E_ARGSERROR Illegal arguments. The waitInterval is less than zero. ERROR: The MQ wait interval was not set successfully.