Summary of DBMS_MGWMSG Object Types and Methods

Table 32-1 DBMS_MGWMSG Object Types and Methods

Object Type	Description
MGW_NAME_VALUE_T Type	Specifies a named value
MGW_NAME_VALUE_T.CONSTRUCT Method	Constructs a new MGW_NAME_VALUE_T instance
MGW_NAME_VALUE_T.CONSTRUCT_<TYPE> Methods	Constructs a new MGW_NAME_VALUE_T instance initialized with the value of a specific type
MGW_NAME_TYPE_ARRAY_T Type	Specifies an array of name-value pairs
MGW_TEXT_VALUE_T Type	Specifies a TEXT value
MGW_TEXT_VALUE_T.CONSTRUCT Method	Constructs a new MGW_TEXT_VALUE_T instance
MGW_RAW_VALUE_T Type	Specifies a RAW value
MGW_RAW_VALUE_T.CONSTRUCT Method	Constructs a new MGW_RAW_VALUE_T instance
MGW_BASIC_MSG_T Type	A canonical type for a basic TEXT or RAW message
MGW_BASIC_MSG_T.CONSTRUCT Method	Constructs a new MGW_BASIC_MSG_T instance

MGW_NAME_VALUE_T Type

This type specifies a named value. The name and type attributes and one of the < >_value attributes are typically nonnull.

Syntax

TYPE SYS.MGW_NAME_VALUE_T IS OBJECT
   name               VARCHAR2(250),
   type               INTEGER,
   integer_value      INTEGER,
   number_value       NUMBER,
   text_value         VARCHAR2(4000),
   raw_value          RAW(2000),
   date_value         DATE);

Attributes

Table 32-2 MGW_NAME_VALUE_T Attributes

Attribute	Description
name	Name associated with the value
type	Value type. Refer to the DBMS_MGWMSG.< >_VALUE constants in Table 32-7. This indicates which Java datatype and class are associated with the value. It also indicates which attribute stores the value.
integer_value	Stores a numeric integer value
number_value	Stores a numeric float or large integer value
text_value	Stores a TEXT value
raw_value	Stores a RAW (bytes) value
date_value	Stores a date value

Type-Attribute Mapping

Table 32-3 shows the mapping between the value type and the attribute used to store the value.

Table 32-3 Type-Attribute Mapping

Type	Value Stored in Attribute
DBMS_MGWMSG.TEXT_VALUE	text_value
DBMS_MGWMSG.RAW_VALUE	raw_value
DBMS_MGWMSG.BOOLEAN_VALUE	integer_value
DBMS_MGWMSG.BYTE_VALUE	integer_value
DBMS_MGWMSG.SHORT_VALUE	integer_value
DBMS_MGWMSG.INTEGER_VALUE	integer_value
DBMS_MGWMSG.LONG_VALUE	number_value
DBMS_MGWMSG.FLOAT_VALUE	number_value
DBMS_MGWMSG.DOUBLE_VALUE	number_value
DBMS_MGWMSG.DATE_VALUE	date_value

MGW_NAME_VALUE_T.CONSTRUCT Method

This method constructs a new MGW_NAME_VALUE_T instance. All attributes are assigned a value of NULL.

Syntax

STATIC FUNCTION CONSTRUCT
RETURN SYS.MGW_NAME_VALUE_T;

MGW_NAME_VALUE_T.CONSTRUCT_<TYPE> Methods

These methods construct a new MGW_NAME_VALUE_T instance initialized with the value of a specific type. Each method sets the name and type attributes and one of the < >_value attributes, as shown in the mappings in Table 32-3.

Syntax

STATIC FUNCTION CONSTRUCT_BOOLEAN (
   name   IN VARCHAR2,
   value  IN INTEGER )
RETURN SYS.MGW_NAME_VALUE_T,

STATIC FUNCTION CONSTRUCT_BYTE (
   name   IN VARCHAR2,
   value  IN INTEGER )
RETURN SYS.MGW_NAME_VALUE_T,

STATIC FUNCTION CONSTRUCT_SHORT (
   name   IN VARCHAR2,
   value  IN INTEGER )
RETURN SYS.MGW_NAME_VALUE_T,

STATIC FUNCTION CONSTRUCT_INTEGER (
   name   IN VARCHAR2,
   value  IN INTEGER )
RETURN SYS.MGW_NAME_VALUE_T,

STATIC FUNCTION CONSTRUCT_LONG (
   name   IN VARCHAR2,
   value  IN NUMBER )
RETURN SYS.MGW_NAME_VALUE_T,

STATIC FUNCTION CONSTRUCT_FLOAT (
   name   IN VARCHAR2,
   value  IN NUMBER )
RETURN SYS.MGW_NAME_VALUE_T,

STATIC FUNCTION CONSTRUCT_DOUBLE (
   name   IN VARCHAR2,
   value  IN NUMBER )
RETURN SYS.MGW_NAME_VALUE_T,

STATIC FUNCTION CONSTRUCT_TEXT (
   name   IN VARCHAR2,
   value  IN VARCHAR2 )
RETURN SYS.MGW_NAME_VALUE_T,

STATIC FUNCTION CONSTRUCT_RAW (
   name  IN VARCHAR2,
   value  IN RAW )
RETURN SYS.MGW_NAME_VALUE_T,

STATIC FUNCTION CONSTRUCT_DATE (
   name   IN VARCHAR2,
   value  IN DATE )
RETURN SYS.MGW_NAME_VALUE_T );

Usage Notes

The construct_boolean method sets the value to either DBMS_MGWMSG.BOOLEAN_TRUE or DBMS_MGWMSG.BOOLEAN_FALSE.

MGW_NAME_TYPE_ARRAY_T Type

This type specifies an array of name-value pairs. An object of MGW_NAME_VALUE_ARRAY_T type can have up to 1024 elements.

Syntax

TYPE SYS.MGW_NAME_VALUE_ARRAY_T AS VARRAY (1024) OF SYS.MGW_NAME_VALUE_T;

MGW_TEXT_VALUE_T Type

This type specifies a TEXT value. It can store a large value as a CLOB or a smaller value (size <= 4000) as VARCHAR2. Only one of the < >_ value attributes should be set.

Syntax

TYPE SYS.MGW_TEXT_VALUE_T IS OBJECT
   small_value VARCHAR2(4000),
   large_value CLOB);

Attributes

Table 32-4 MGW_TEXT_VALUE_T Attributes

Attribute	Description
small_value	Small TEXT value. Used for values <= 4000.
large_value	Large TEXT value. Used when the value is too large for the small_value attribute.

MGW_TEXT_VALUE_T.CONSTRUCT Method

This method constructs a new MGW_TEXT_VALUE_T instance. All attributes are assigned a value of NULL.

Syntax

STATIC FUNCTION CONSTRUCT
RETURN SYS.MGW_TEXT_VALUE_T;

MGW_RAW_VALUE_T Type

This type specifies a RAW value. This type can store a large value as a BLOB or a smaller value (size <= 2000) as RAW. Only one of the < >_value attributes should be set.

Syntax

TYPE SYS.MGW_RAW_VALUE_T IS OBJECT(
   small_value RAW(2000),
   large_value BLOB);

Attributes

Table 32-5 MGW_RAW_VALUE_T Attributes

Attribute	Description
small_value	Small RAW (bytes) value <= 2000
large_value	Large RAW value. Used when the value is too large for the small_value attribute.

MGW_RAW_VALUE_T.CONSTRUCT Method

This method constructs a new MGW_RAW_VALUE_T instance. All attributes are assigned a value of NULL.

Syntax

STATIC FUNCTION CONSTRUCT
RETURN SYS.MGW_RAW_VALUE_T;

MGW_BASIC_MSG_T Type

This is a canonical type for a basic TEXT or RAW message. Only a single TEXT or RAW value is typically set. An object of this type should not have both TEXT and RAW set to a nonnull value at the same time.

Syntax

TYPE SYS.MGW_BASIC_MSG_T IS OBJECT
   header     SYS.MGW_NAME_VALUE_ARRAY_T,
   text_body  SYS.MGW_TEXT_VALUE_T,
   raw_body   SYS.MGW_RAW_VALUE_T);

Attributes

Table 32-6 MGW_BASIC_MSG_T Attributes

Attribute	Description
header	Message header information as an array of name-value pairs
text_body	Message body for a TEXT message
raw_body	Message body for a RAW (bytes) message

MGW_BASIC_MSG_T.CONSTRUCT Method

This method constructs a new MGW_BASIC_MSG_T instance. All attributes are assigned a value of NULL.

Syntax

STATIC FUNCTION CONSTRUCT
RETURN SYS.MGW_BASIC_MSG_T;