com.ibm.ims.jms

Interface IMSCalloutControlArea

public interface IMSCalloutControlArea

The IMSCalloutControlArea contains all the control area data items.

The IMS Callout Control Area contains data in the following format. LLLL <tag1> controlDataItem1 </tag1> <tag2> controlDataItem2 </tag2> ... The LLLL field is a four byte length that is automatically calculated. Control items area added to the control area in the order that they are called.

Field Summary

Fields

Modifier and Type	Field and Description
static int	PACKED_DECIMAL
static int	ZONED_DECIMAL

Method Summary

Modifier and Type	Method and Description
void	addControlDataItem(java.lang.String tag, java.math.BigDecimal data, int type, boolean isSigned) Adds the BigDecimal control data item into the IMSCalloutControlArea.
void	addControlDataItem(java.lang.String tag, java.lang.Boolean data) Adds the Boolean control data item into the IMSCalloutControlArea.
void	addControlDataItem(java.lang.String tag, java.lang.Byte data) Adds the Byte control data item into the IMSCalloutControlArea.
void	addControlDataItem(java.lang.String tag, byte[] data) Adds the byte[] control data item into the IMSCalloutControlArea.
void	addControlDataItem(java.lang.String tag, java.sql.Date data) Adds the Date control data item into the IMSCalloutControlArea.
void	addControlDataItem(java.lang.String tag, java.lang.Double data) Adds the Double control data item into the IMSCalloutControlArea.
void	addControlDataItem(java.lang.String tag, java.lang.Float data) Adds the Float control data item into the IMSCalloutControlArea.
void	addControlDataItem(java.lang.String tag, java.lang.Integer data) Adds the Integer control data item into the IMSCalloutControlArea.
void	addControlDataItem(java.lang.String tag, java.lang.Long data) Adds the Long control data item into the IMSCalloutControlArea.
void	addControlDataItem(java.lang.String tag, java.lang.Short data) Adds the Short control data item into the IMSCalloutControlArea.
void	addControlDataItem(java.lang.String tag, java.lang.String data) Adds the String control data item into the IMSCalloutControlArea.
void	addControlDataItem(java.lang.String tag, java.lang.String data, java.lang.String encoding) Adds the String control data item into the IMSCalloutControlArea.
void	addControlDataItem(java.lang.String tag, java.sql.Time data) Adds the Time control data item into the IMSCalloutControlArea.
void	addControlDataItem(java.lang.String tag, java.sql.Timestamp data) Adds the Timestamp control data item into the IMSCalloutControlArea.

Field Detail

PACKED_DECIMAL

static final int PACKED_DECIMAL

See Also:

Constant Field Values

ZONED_DECIMAL

static final int ZONED_DECIMAL

See Also:

Constant Field Values

Method Detail

addControlDataItem

void addControlDataItem(java.lang.String tag,
                        java.lang.Boolean data)
                 throws javax.jms.JMSException

Adds the Boolean control data item into the IMSCalloutControlArea.

Parameters:

tag - the tag (identifier) for the control data item to be added

data - the Boolean data of the control data item to be added

Throws:

javax.jms.JMSException - if the control data item cannot be added

addControlDataItem

void addControlDataItem(java.lang.String tag,
                        java.lang.Byte data)
                 throws javax.jms.JMSException

Adds the Byte control data item into the IMSCalloutControlArea.

Parameters:

tag - the tag (identifier) for the control data item to be added

data - the Byte data of the control data item to be added

Throws:

javax.jms.JMSException - if the control data item cannot be added

addControlDataItem

void addControlDataItem(java.lang.String tag,
                        byte[] data)
                 throws javax.jms.JMSException

Adds the byte[] control data item into the IMSCalloutControlArea.

Parameters:

tag - the tag (identifier) for the control data item to be added

data - the byte[] data of the control data item to be added

Throws:

javax.jms.JMSException - if the control data item cannot be added

addControlDataItem

void addControlDataItem(java.lang.String tag,
                        java.sql.Date data)
                 throws javax.jms.JMSException

Adds the Date control data item into the IMSCalloutControlArea.

Parameters:

tag - the tag (identifier) for the control data item to be added

data - the Date data of the control data item to be added

Throws:

javax.jms.JMSException - if the control data item cannot be added

addControlDataItem

void addControlDataItem(java.lang.String tag,
                        java.lang.Double data)
                 throws javax.jms.JMSException

Adds the Double control data item into the IMSCalloutControlArea.

Parameters:

tag - the tag (identifier) for the control data item to be added

data - the Double data of the control data item to be added

Throws:

javax.jms.JMSException - if the control data item cannot be added

addControlDataItem

void addControlDataItem(java.lang.String tag,
                        java.lang.Float data)
                 throws javax.jms.JMSException

Adds the Float control data item into the IMSCalloutControlArea.

Parameters:

tag - the tag (identifier) for the control data item to be added

data - the Float data of the control data item to be added

Throws:

javax.jms.JMSException - if the control data item cannot be added

addControlDataItem

void addControlDataItem(java.lang.String tag,
                        java.lang.Integer data)
                 throws javax.jms.JMSException

Adds the Integer control data item into the IMSCalloutControlArea.

Parameters:

tag - the tag (identifier) for the control data item to be added

data - the Integer data of the control data item to be added

Throws:

javax.jms.JMSException - if the control data item cannot be added

addControlDataItem

void addControlDataItem(java.lang.String tag,
                        java.lang.Long data)
                 throws javax.jms.JMSException

Adds the Long control data item into the IMSCalloutControlArea.

Parameters:

tag - the tag (identifier) for the control data item to be added

data - the Long data of the control data item to be added

Throws:

javax.jms.JMSException - if the control data item cannot be added

addControlDataItem

void addControlDataItem(java.lang.String tag,
                        java.math.BigDecimal data,
                        int type,
                        boolean isSigned)
                 throws javax.jms.JMSException

Adds the BigDecimal control data item into the IMSCalloutControlArea.

Parameters:

tag - the tag (identifier) for the control data item to be added

data - the BigDecimal data of the control data item to be added

Throws:

javax.jms.JMSException - if the control data item cannot be added

addControlDataItem

void addControlDataItem(java.lang.String tag,
                        java.lang.String data)
                 throws javax.jms.JMSException

Adds the String control data item into the IMSCalloutControlArea. The encoding of the String data is assumed to be Cp1047

Parameters:

tag - the tag (identifier) for the control data item to be added

data - the String data of the control data item to be added

Throws:

javax.jms.JMSException - if the control data item cannot be added

addControlDataItem

void addControlDataItem(java.lang.String tag,
                        java.lang.String data,
                        java.lang.String encoding)
                 throws javax.jms.JMSException

Adds the String control data item into the IMSCalloutControlArea.

Parameters:

tag - the tag (identifier) for the control data item to be added

data - the String data of the control data item to be added

encoding - the encoding for the String data of the control data item

Throws:

javax.jms.JMSException - if the control data item cannot be added

addControlDataItem

void addControlDataItem(java.lang.String tag,
                        java.lang.Short data)
                 throws javax.jms.JMSException

Adds the Short control data item into the IMSCalloutControlArea.

Parameters:

tag - the tag (identifier) for the control data item to be added

data - the Short data of the control data item to be added

Throws:

javax.jms.JMSException - if the control data item cannot be added

addControlDataItem

void addControlDataItem(java.lang.String tag,
                        java.sql.Time data)
                 throws javax.jms.JMSException

Adds the Time control data item into the IMSCalloutControlArea.

Parameters:

tag - the tag (identifier) for the control data item to be added

data - the Time data of the control data item to be added

Throws:

javax.jms.JMSException - if the control data item cannot be added

addControlDataItem

void addControlDataItem(java.lang.String tag,
                        java.sql.Timestamp data)
                 throws javax.jms.JMSException

Adds the Timestamp control data item into the IMSCalloutControlArea.

Parameters:

tag - the tag (identifier) for the control data item to be added

data - the Timestamp data of the control data item to be added

Throws:

javax.jms.JMSException - if the control data item cannot be added