bea.jolt

Interface Message

All Known Implementing Classes:

JoltMessage, JoltRemoteService, JoltView32

public interface Message

This interface provides the set, get, add, and delete methods to interact with any instance of an item in the message object.

Method Summary

Methods

Modifier and Type	Method and Description
void	addByte(java.lang.String name, byte val) Add a byte item referred by its name.
void	addBytes(java.lang.String name, byte[] val, int len) Add a byte-array item referred by its name.
void	addDouble(java.lang.String name, double val) Add a double item referred by its name.
void	addFloat(java.lang.String name, float val) Add a float item referred by its name.
void	addInt(java.lang.String name, int val) Add a int item referred by its name.
void	addMBString(java.lang.String name, java.lang.String val) Add a mbstring item referred by its name.
void	addShort(java.lang.String name, short val) Add a short item referred by its name.
void	addString(java.lang.String name, java.lang.String val) Add a string item referred by its name.
void	clear() Remove all items from the message.
void	delete(java.lang.String name) Delete the first item with the matching name.
void	deleteItem(java.lang.String name, int itemNo) Delete an occurrence of an item referred by its name.
byte	getByteDef(java.lang.String name, byte def) Get the first item based on its name.
byte	getByteItemDef(java.lang.String name, int itemNo, byte def) Get an occurrence of a named item of byte data type.
byte[]	getBytesDef(java.lang.String name, byte[] def) Get the first item based on its name.
byte[]	getBytesItemDef(java.lang.String name, int itemNo, byte[] def) Get an occurrence of a named item of byte-array data type.
double	getDoubleDef(java.lang.String name, double def) Get the first item based on its name.
double	getDoubleItemDef(java.lang.String name, int itemNo, double def) Get an occurrence of a named item of double data type.
float	getFloatDef(java.lang.String name, float def) Get the first item based on its name.
float	getFloatItemDef(java.lang.String name, int itemNo, float def) Get an occurrence of a named item of float data type.
int	getIntDef(java.lang.String name, int def) Get the first item based on its name.
int	getIntItemDef(java.lang.String name, int itemNo, int def) Get an occurrence of a named item of int data type.
java.lang.String	getMBStringDef(java.lang.String name, java.lang.String def) Get the first item based on its name.
java.lang.String	getMBStringItemDef(java.lang.String name, int itemNo, java.lang.String def) Get an occurrence of a named item of mbstring data type.
int	getOccurrenceCount(java.lang.String name) Get the number of occurrence of a named item.
short	getShortDef(java.lang.String name, short def) Get the first item based on its name.
short	getShortItemDef(java.lang.String name, int itemNo, short def) Get an occurrence of a named item of short data type.
java.lang.String	getStringDef(java.lang.String name, java.lang.String def) Get the first item based on its name.
java.lang.String	getStringItemDef(java.lang.String name, int itemNo, java.lang.String def) Get an occurrence of a named item of string data type.
void	setByte(java.lang.String name, byte val) Change the value for the first instance of the named item of byte data type.
void	setByteItem(java.lang.String name, int itemNo, byte val) Change the byte value of an occurrence of the named item.
void	setBytes(java.lang.String name, byte[] val, int len) Change the value for the first instance of the named item of byte-array data type.
void	setBytesItem(java.lang.String name, int itemNo, byte[] val, int len) Change the byte-array value of an occurrence of the named item.
void	setDouble(java.lang.String name, double val) Change the value for the first instance of the named item of a double data type.
void	setDoubleItem(java.lang.String name, int itemNo, double val) Change the double value of an occurrence of the named item.
void	setFloat(java.lang.String name, float val) Change the value for the first instance of the named item of a float data type.
void	setFloatItem(java.lang.String name, int itemNo, float val) Change the float value of an occurrence of the named item.
void	setInt(java.lang.String name, int val) Change the value for the first instance of the named item of an int data type.
void	setIntItem(java.lang.String name, int itemNo, int val) Change the int value of an occurrence of the named item.
void	setMBString(java.lang.String name, java.lang.String val) Change the value for the first instance of the named item of a mbstring data type.
void	setMBStringItem(java.lang.String name, int itemNo, java.lang.String val) Change the mbstring value of an occurrence of the named item.
void	setShort(java.lang.String name, short val) Change the value for the first instance of the named item of a short data type.
void	setShortItem(java.lang.String name, int itemNo, short val) Change the short value of an occurrence of the named item.
void	setString(java.lang.String name, java.lang.String val) Change the value for the first instance of the named item of a string data type.
void	setStringItem(java.lang.String name, int itemNo, java.lang.String val) Change the string value of an occurrence of the named item.

Method Detail

clear

void clear()

Remove all items from the message.

setByte

void setByte(java.lang.String name,
           byte val)

Change the value for the first instance of the named item of byte data type. If the item does not exist, it will be added.

Parameters:

name - The name of the item to be set or changed.

val - The byte value to be set or changed to.

Throws:

java.lang.NoSuchFieldError - It is an invalid name.

java.lang.IllegalAccessError - It is an output item.

setShort

void setShort(java.lang.String name,
            short val)

Change the value for the first instance of the named item of a short data type. If the item does not exist, it will be added.

Parameters:

name - The name of the item to be set or changed.

val - The short value to be set or changed to.

Throws:

java.lang.NoSuchFieldError - It is an invalid name.

java.lang.IllegalAccessError - It is an output item.

setInt

void setInt(java.lang.String name,
          int val)

Change the value for the first instance of the named item of an int data type. If the item does not exist, it will be added.

Parameters:

name - The name of the item to be set or changed.

val - The int value to be set or changed to.

Throws:

java.lang.NoSuchFieldError - It is an invalid name.

java.lang.IllegalAccessError - It is an output item.

setFloat

void setFloat(java.lang.String name,
            float val)

Change the value for the first instance of the named item of a float data type. If the item does not exist, it will be added.

Parameters:

name - The name of the item to be set or changed.

val - The float value to be set or changed to.

Throws:

java.lang.NoSuchFieldError - It is an invalid name.

java.lang.IllegalAccessError - It is an output item.

setDouble

void setDouble(java.lang.String name,
             double val)

Change the value for the first instance of the named item of a double data type. If the item does not exist, it will be added.

Parameters:

name - The name of the item to be set or changed.

val - The double value to be set or changed to.

Throws:

java.lang.NoSuchFieldError - It is an invalid name.

java.lang.IllegalAccessError - It is an output item.

setString

void setString(java.lang.String name,
             java.lang.String val)

Change the value for the first instance of the named item of a string data type. If the item does not exist, it will be added.

Parameters:

name - The name of the item to be set or changed.

val - The string value to be set or changed to.

Throws:

java.lang.NoSuchFieldError - It is an invalid name.

java.lang.IllegalAccessError - It is an output item.

setBytes

void setBytes(java.lang.String name,
            byte[] val,
            int len)

Change the value for the first instance of the named item of byte-array data type. If the item does not exist, it will be added.

Parameters:

name - The name of the item to be set or changed.

val - The byte-array value to be set or changed to.

Throws:

java.lang.NoSuchFieldError - It is an invalid name.

java.lang.IllegalAccessError - It is an output item.

setMBString

void setMBString(java.lang.String name,
               java.lang.String val)

Change the value for the first instance of the named item of a mbstring data type. If the item does not exist, it will be added.

Parameters:

name - The name of the item to be set or changed.

val - The mbstring value to be set or changed to.

Throws:

java.lang.NoSuchFieldError - It is an invalid name.

java.lang.IllegalAccessError - It is an output item.

getByteDef

byte getByteDef(java.lang.String name,
              byte def)

Get the first item based on its name. If it does not exist, the default value will be returned.

Parameters:

name - The name of the item.

def - The default byte value.

Throws:

java.lang.NoSuchFieldError - It is an invalid name.

java.lang.IllegalAccessError - It is not an output item.

getShortDef

short getShortDef(java.lang.String name,
                short def)

Get the first item based on its name. If it does not exist, the default value will be returned.

Parameters:

name - The name of the item.

def - The default short value.

Throws:

java.lang.NoSuchFieldError - It is an invalid name.

java.lang.IllegalAccessError - It is not an output item.

getIntDef

int getIntDef(java.lang.String name,
            int def)

Get the first item based on its name. If it does not exist, the default value will be returned.

Parameters:

name - The name of the item.

def - The default int value.

Throws:

java.lang.NoSuchFieldError - It is an invalid name.

java.lang.IllegalAccessError - It is not an output item.

getFloatDef

float getFloatDef(java.lang.String name,
                float def)

Get the first item based on its name. If it does not exist, the default value will be returned.

Parameters:

name - The name of the item.

def - The default float value.

Throws:

java.lang.NoSuchFieldError - It is an invalid name.

java.lang.IllegalAccessError - It is not an output item.

getDoubleDef

double getDoubleDef(java.lang.String name,
                  double def)

Get the first item based on its name. If it does not exist, the default value will be returned.

Parameters:

name - The name of the item.

def - The default double value.

Throws:

java.lang.NoSuchFieldError - It is an invalid name.

java.lang.IllegalAccessError - It is not an output item.

getStringDef

java.lang.String getStringDef(java.lang.String name,
                            java.lang.String def)

Get the first item based on its name. If it does not exist, the default value will be returned.

Parameters:

name - The name of the item.

def - The default string value.

Throws:

java.lang.NoSuchFieldError - It is an invalid name.

java.lang.IllegalAccessError - It is not an output item.

getBytesDef

byte[] getBytesDef(java.lang.String name,
                 byte[] def)

Get the first item based on its name. If it does not exist, the default value will be returned.

Parameters:

name - The name of the item.

def - The default byte-array value.

Throws:

java.lang.NoSuchFieldError - It is an invalid name.

java.lang.IllegalAccessError - It is not an output item.

getMBStringDef

java.lang.String getMBStringDef(java.lang.String name,
                              java.lang.String def)

Get the first item based on its name. If it does not exist, the default value will be returned.

Parameters:

name - The name of the item.

def - The default mbstring value.

Throws:

java.lang.NoSuchFieldError - It is an invalid name.

java.lang.IllegalAccessError - It is not an output item.

addByte

void addByte(java.lang.String name,
           byte val)

Add a byte item referred by its name. Usually the added item should be position independent. To minimize any programming error, use the alias field if the item has multiple occurrence and the position of the item is important.

Parameters:

name - The name of the item to be added.

val - The byte value to be added.

Throws:

java.lang.NoSuchFieldError - It is an invalid name.

java.lang.IllegalAccessError - It is an output item.

IllegalMethodException - Cannot use this method on alias field.

addShort

void addShort(java.lang.String name,
            short val)

Add a short item referred by its name. Usually the added item should be position independent. To minimize any programming error, use the alias field if the item has multiple occurrence and the position of the item is important.

Parameters:

name - The name of the item to be added.

val - The short value to be added.

Throws:

java.lang.NoSuchFieldError - It is an invalid name.

java.lang.IllegalAccessError - It is an output item.

IllegalMethodException - Cannot use this method on alias field.

addInt

void addInt(java.lang.String name,
          int val)

Add a int item referred by its name. Usually the added item should be position independent. To minimize any programming error, use the alias field if the item has multiple occurrence and the position of the item is important.

Parameters:

name - The name of the item to be added.

val - The int value to be added.

Throws:

java.lang.NoSuchFieldError - It is an invalid name.

java.lang.IllegalAccessError - It is an output item.

IllegalMethodException - Cannot use this method on alias field.

addFloat

void addFloat(java.lang.String name,
            float val)

Add a float item referred by its name. Usually the added item is position-independent. To minimize any programming error, use the alias field if the item has multiple occurrence and the position of the item is important.

Parameters:

name - The name of the item to be added.

val - The float value to be added.

Throws:

java.lang.NoSuchFieldError - It is an invalid name.

java.lang.IllegalAccessError - It is an output item.

IllegalMethodException - Cannot use this method on alias field.

addDouble

void addDouble(java.lang.String name,
             double val)

Add a double item referred by its name. Usually the added item is position-independent. To minimize any programming error, use the alias field if the item has multiple occurrence and the position of the item is important.

Parameters:

name - The name of the item to be added.

val - The double value to be added.

Throws:

java.lang.NoSuchFieldError - It is an invalid name.

java.lang.IllegalAccessError - It is an output item.

IllegalMethodException - Cannot use this method on alias field.

addString

void addString(java.lang.String name,
             java.lang.String val)

Add a string item referred by its name. Usually the added item is position-independent. To minimize programming errors, use the alias field if the item has multiple occurrences and the position of the item is important.

Parameters:

name - The name of the item to be added.

val - The string value to be added.

Throws:

java.lang.NoSuchFieldError - It is an invalid name.

java.lang.IllegalAccessError - It is an output item.

IllegalMethodException - Cannot use this method on alias field.

addBytes

void addBytes(java.lang.String name,
            byte[] val,
            int len)

Add a byte-array item referred by its name. Usually the added item should be position independent. To minimize any programming error, use the alias field if the item has multiple occurrence and the position of the item is important.

Parameters:

name - The name of the item to be added.

val - The byte-array value to be added.

len - The number of bytes to be added.

Throws:

java.lang.NoSuchFieldError - It is an invalid name.

java.lang.IllegalAccessError - It is an output item.

IllegalMethodException - Cannot use this method on alias field.

addMBString

void addMBString(java.lang.String name,
               java.lang.String val)

Add a mbstring item referred by its name. Usually the added item is position-independent. To minimize programming errors, use the alias field if the item has multiple occurrences and the position of the item is important.

Parameters:

name - The name of the item to be added.

val - The mbstring value to be added.

Throws:

java.lang.NoSuchFieldError - It is an invalid name.

java.lang.IllegalAccessError - It is an output item.

IllegalMethodException - Cannot use this method on alias field.

setByteItem

void setByteItem(java.lang.String name,
               int itemNo,
               byte val)

Change the byte value of an occurrence of the named item. The occurrence number starts at 0. If the item does not exist, it will be added. All prior non-existing instances will be added with a null default value.

Parameters:

name - The name of the item.

itemNo - The occurrence number.

val - The byte value.

Throws:

java.lang.NoSuchFieldError - It is an invalid name.

java.lang.IllegalAccessError - It is an output item.

setShortItem

void setShortItem(java.lang.String name,
                int itemNo,
                short val)

Change the short value of an occurrence of the named item. The occurrence number starts at 0. If the item does not exist, it will be added. All prior non-existing instances will be added with default value of 0.

Parameters:

name - The name of the item.

itemNo - The occurrence number.

val - The short value.

Throws:

java.lang.NoSuchFieldError - It is an invalid name.

java.lang.IllegalAccessError - It is an output item.

setIntItem

void setIntItem(java.lang.String name,
              int itemNo,
              int val)

Change the int value of an occurrence of the named item. The occurrence number starts at 0. If the item does not exist, it will be added. All prior non-existing instances will be added with default 0 value.

Parameters:

name - The name of the item.

itemNo - The occurrence number.

val - The int value.

Throws:

java.lang.NoSuchFieldError - It is an invalid name.

java.lang.IllegalAccessError - It is an output item.

setFloatItem

void setFloatItem(java.lang.String name,
                int itemNo,
                float val)

Change the float value of an occurrence of the named item. The occurrence number starts at 0. If the item does not exist, it will be added. All prior non-existing instances will be inserted with default value of 0.0.

Parameters:

name - The name of the item.

itemNo - The occurrence number.

val - The float value.

Throws:

java.lang.NoSuchFieldError - It is an invalid name.

java.lang.IllegalAccessError - It is an output item.

setDoubleItem

void setDoubleItem(java.lang.String name,
                 int itemNo,
                 double val)

Change the double value of an occurrence of the named item. The occurrence number starts at 0. If the item does not exist, it will be added. All prior non-existing instances will be inserted with default value 0.0.

Parameters:

name - The name of the item.

itemNo - The occurrence number.

val - The double value.

Throws:

java.lang.NoSuchFieldError - It is an invalid name.

java.lang.IllegalAccessError - It is an output item.

setStringItem

void setStringItem(java.lang.String name,
                 int itemNo,
                 java.lang.String val)

Change the string value of an occurrence of the named item. The occurrence number starts at 0. If the item does not exist, it will be added. All prior non-existing instances will be added with default "" value.

Parameters:

name - The name of the item.

itemNo - The occurrence number.

val - The string value.

Throws:

java.lang.NoSuchFieldError - It is an invalid name.

java.lang.IllegalAccessError - It is an output item.

setBytesItem

void setBytesItem(java.lang.String name,
                int itemNo,
                byte[] val,
                int len)

Change the byte-array value of an occurrence of the named item. The occurrence number starts at 0. If the item does not exist, it will be added. All prior non-existing instances will be inserted with default null value.

Parameters:

name - The name of the item.

itemNo - The occurrence number.

val - The byte-array value.

len - The length of the byte-array.

Throws:

java.lang.NoSuchFieldError - It is an invalid name.

java.lang.IllegalAccessError - It is an output item.

setMBStringItem

void setMBStringItem(java.lang.String name,
                   int itemNo,
                   java.lang.String val)

Change the mbstring value of an occurrence of the named item. The occurrence number starts at 0. If the item does not exist, it will be added. All prior non-existing instances will be added with default "" value.

Parameters:

name - The name of the item.

itemNo - The occurrence number.

val - The mbstring value.

Throws:

java.lang.NoSuchFieldError - It is an invalid name.

java.lang.IllegalAccessError - It is an output item.

delete

void delete(java.lang.String name)

Delete the first item with the matching name.

Parameters:

name - The name of the item to be deleted.

Throws:

java.lang.NoSuchFieldError - It is an invalid name.

java.lang.IllegalAccessError - Cannot delete an input item.

deleteItem

void deleteItem(java.lang.String name,
              int itemNo)

Delete an occurrence of an item referred by its name. The occurrence starts at 0.

Parameters:

name - The name of the item to be deleted.

itemNo - Occurrence number of the item.

Throws:

java.lang.NoSuchFieldError - It is an invalid name.

java.lang.IllegalAccessError - Cannot delete an input item.

java.lang.IndexOutOfBoundsException - The itemNo for an alias field is not 0.

getOccurrenceCount

int getOccurrenceCount(java.lang.String name)

Get the number of occurrence of a named item.

Parameters:

name - The name of the item.

Throws:

java.lang.NoSuchFieldError - It is an invalid name.

java.lang.IllegalAccessError - It is not an output item.

getByteItemDef

byte getByteItemDef(java.lang.String name,
                  int itemNo,
                  byte def)

Get an occurrence of a named item of byte data type. The occurrence starts from 0. If it does not exist, the default value will be returned.

Parameters:

name - Name of the item.

itemNo - Occurrence number of the item.

def - Default value.

Returns:

A byte value.

Throws:

java.lang.NoSuchFieldError - It is an invalid name.

java.lang.IllegalAccessError - It is an output item.

java.lang.IndexOutOfBoundsException - The itemNo for an alias field is not 0.

getShortItemDef

short getShortItemDef(java.lang.String name,
                    int itemNo,
                    short def)

Get an occurrence of a named item of short data type. The occurrence starts from 0. If it does not exist, the default value will be returned.

Parameters:

name - Name of the item.

itemNo - Occurrence number of the item.

def - Default value.

Returns:

A short value.

Throws:

java.lang.NoSuchFieldError - It is an invalid name.

java.lang.IllegalAccessError - It is an output item.

java.lang.IndexOutOfBoundsException - The itemNo for an alias field is not 0.

getIntItemDef

int getIntItemDef(java.lang.String name,
                int itemNo,
                int def)

Get an occurrence of a named item of int data type. The occurrence starts from 0. If it does not exist, the default value will be returned.

Parameters:

name - Name of the item.

itemNo - Occurrence number of the item.

def - Default value.

Returns:

An int value.

Throws:

java.lang.NoSuchFieldError - It is an invalid name.

java.lang.IllegalAccessError - It is an output item.

java.lang.IndexOutOfBoundsException - The itemNo for an alias field is not 0.

getFloatItemDef

float getFloatItemDef(java.lang.String name,
                    int itemNo,
                    float def)

Get an occurrence of a named item of float data type. The occurrence starts from 0. If it does not exist, the default value will be returned.

Parameters:

name - Name of the item.

itemNo - Occurrence number of the item.

def - Default value.

Returns:

A float value.

Throws:

java.lang.NoSuchFieldError - It is an invalid name.

java.lang.IllegalAccessError - It is an output item.

java.lang.IndexOutOfBoundsException - The itemNo for an alias field is not 0.

getDoubleItemDef

double getDoubleItemDef(java.lang.String name,
                      int itemNo,
                      double def)

Get an occurrence of a named item of double data type. The occurrence starts from 0. If it does not exist, the default value will be returned.

Parameters:

name - Name of the item.

itemNo - Occurrence number of the item.

def - Default value.

Returns:

A double value.

Throws:

java.lang.NoSuchFieldError - It is an invalid name.

java.lang.IllegalAccessError - It is an output item.

java.lang.IndexOutOfBoundsException - The itemNo for an alias field is not 0.

getStringItemDef

java.lang.String getStringItemDef(java.lang.String name,
                                int itemNo,
                                java.lang.String def)

Get an occurrence of a named item of string data type. The occurrence starts from 0. If it does not exist, the default value will be returned.

Parameters:

name - Name of the item.

itemNo - Occurrence number of the item.

def - Default value.

Returns:

A string value.

Throws:

java.lang.NoSuchFieldError - It is an invalid name.

java.lang.IllegalAccessError - It is an output item.

java.lang.IndexOutOfBoundsException - The itemNo for an alias field is not 0.

getBytesItemDef

byte[] getBytesItemDef(java.lang.String name,
                     int itemNo,
                     byte[] def)

Get an occurrence of a named item of byte-array data type. The occurrence starts from 0. If it does not exist, the default value will be returned.

Parameters:

name - Name of the item.

itemNo - Occurrence number of the item.

def - Default value.

Returns:

A byte-array object.

Throws:

java.lang.NoSuchFieldError - It is an invalid name.

java.lang.IllegalAccessError - It is an output item.

java.lang.IndexOutOfBoundsException - The itemNo for an alias field is not 0.

getMBStringItemDef

java.lang.String getMBStringItemDef(java.lang.String name,
                                  int itemNo,
                                  java.lang.String def)

Get an occurrence of a named item of mbstring data type. The occurrence starts from 0. If it does not exist, the default value will be returned.

Parameters:

name - Name of the item.

itemNo - Occurrence number of the item.

def - Default value.

Returns:

A mbstring value.

Throws:

java.lang.NoSuchFieldError - It is an invalid name.

java.lang.IllegalAccessError - It is an output item.

java.lang.IndexOutOfBoundsException - The itemNo for an alias field is not 0.