Skip Headers

Oracle9i Supplied PL/SQL Packages and Types Reference
Release 2 (9.2)

Part Number A96612-01
Go To Documentation Library
Home
Go To Product List
Book List
Go To Table Of Contents
Contents
Go To Index
Index

Master Index

Feedback

Go to previous page Go to beginning of chapter Go to next page

JMS Types, 3 of 5


Summary of JMS Types

This chapter discusses the following JMS types:

aq$_jms_userproperty Type

This type is used to store an individual user-specified JMS message user property.

Syntax

TYPE aq$_jms_userproperty AS object(
   name        VARCHAR(100),
   type        INT,
   str_value   VARCHAR(2000),
   num_value   NUMBER,
   java_type   INT);

aq$_jms_userproparray Type

This type is used to store the list of JMS user-specified message properties for a given JMS message.

Syntax

TYPE aq$_jms_userproparray AS varray(100) of aq$_jms_userproperty;

aq$_jms_header Type

This type is used to store the JMS message header values for a given JMS message.

Syntax

TYPE aq$_jms_header AS object(
   replyto     sys.aq$_agent,
   type        VARCHAR(100),
   userid      VARCHAR(100),
   appid       VARCHAR(100),
   groupid     VARCHAR(100),
   groupseq    INT,
   properties  aq$_jms_userproparray,
   MEMBER PROCEDURE lookup_property_name (new_property_name IN VARCHAR),
   MEMBER PROCEDURE set_replyto          (replyto           IN sys.aq$_agent),
   MEMBER PROCEDURE set_type             (type              IN VARCHAR),
   MEMBER PROCEDURE set_userid           (userid            IN VARCHAR),
   MEMBER PROCEDURE set_appid            (appid             IN VARCHAR),
   MEMBER PROCEDURE set_groupid          (groupid           IN VARCHAR),
   MEMBER PROCEDURE set_groupseq         (groupseq          IN INT),
   MEMBER PROCEDURE clear_properties,
   MEMBER PROCEDURE set_boolean_property(
      property_name   IN  VARCHAR,
      property_value  IN  BOOLEAN),
   MEMBER PROCEDURE set_byte_property(
     property_name   IN  VARCHAR,
     property_value  IN  INT ),
   MEMBER PROCEDURE set_short_property (
     property_name   IN  VARCHAR,
     property_value  IN  INT ),
   MEMBER PROCEDURE set_int_property (
      property_name   IN  VARCHAR,
      property_value  IN  INT ),
   MEMBER PROCEDURE set_long_property (
      property_name   IN  VARCHAR,
      property_value  IN  NUMBER ),
  MEMBER PROCEDURE set_float_property (
      property_name   IN  VARCHAR,
      property_value  IN  FLOAT ),
  MEMBER PROCEDURE set_double_property (
      property_name   IN  VARCHAR,
      property_value  IN  DOUBLE PRECISION ),
  MEMBER PROCEDURE set_string_property (
      property_name   IN  VARCHAR,
      property_value  IN  VARCHAR ),
  MEMBER FUNCTION get_replyto  RETURN sys.aq$_agent,
  MEMBER FUNCTION get_type     RETURN VARCHAR,
  MEMBER FUNCTION get_userid   RETURN VARCHAR,
  MEMBER FUNCTION get_appid    RETURN VARCHAR,
  MEMBER FUNCTION get_groupid  RETURN VARCHAR,
  MEMBER FUNCTION get_groupseq RETURN INT,
  MEMBER FUNCTION get_boolean_property (property_name IN  VARCHAR)
    RETURN   BOOLEAN,
  MEMBER FUNCTION get_byte_property    (property_name IN  VARCHAR)
    RETURN   INT,
  MEMBER FUNCTION get_short_property   (property_name IN  VARCHAR)
    RETURN   INT,
  MEMBER FUNCTION get_int_property     (property_name IN  VARCHAR)
    RETURN   INT,
  MEMBER FUNCTION get_long_property    (property_name IN  VARCHAR)
    RETURN   NUMBER,
  MEMBER FUNCTION get_float_property   (property_name IN  VARCHAR)
    RETURN   FLOAT,
  MEMBER FUNCTION get_double_property  (property_name IN  VARCHAR)
    RETURN   DOUBLE PRECISION,
  MEMBER FUNCTION get_string_property  (property_name IN  VARCHAR)
    RETURN   VARCHAR);

aq$_jms_message Type

This type is the ADT used to store JMS messages of all the JMS -specified message types: JMSText, JMSBytes, JMSMap, JMSStream, and JMSObject.

The static function contruct defined as a part of aq$_jms_message is

STATIC FUNCTION construct ( mtype IN int ) RETURN aq$_jms_message. 

See "CONSTRUCT Static Function" for more information.

Syntax

TYPE aq$_jms_message AS object(
   header        aq$_jms_header, 
   senderid      varchar2(100), 
   message_type  INT, 
   text_len      INT, 
   bytes_len     INT, 
   text_vc       varchar2(4000), 
   bytes_raw     raw(2000), 
   text_lob      clob, 
   bytes_lob     blob, 
   STATIC FUNCTION construct     (mtype    IN  INT) RETURN aq$_jms_message, 
   MEMBER PROCEDURE set_text     (payload  IN  VARCHAR2), 
   MEMBER PROCEDURE set_text     (payload  IN  CLOB), 
   MEMBER PROCEDURE get_text     (payload  OUT VARCHAR2), 
   MEMBER PROCEDURE get_text     (payload  OUT CLOB), 
   MEMBER PROCEDURE set_bytes    (payload  IN  RAW), 
   MEMBER PROCEDURE set_bytes    (payload  IN  BLOB), 
   MEMBER PROCEDURE get_bytes    (payload  OUT RAW), 
   MEMBER PROCEDURE get_bytes    (payload  OUT BLOB), 
   MEMBER PROCEDURE set_replyto  (replyto  IN  sys.aq$_agent), 
   MEMBER PROCEDURE set_type     (type     IN  VARCHAR), 
   MEMBER PROCEDURE set_userid   (userid   IN  VARCHAR), 
   MEMBER PROCEDURE set_appid    (appid    IN  VARCHAR), 
   MEMBER PROCEDURE set_groupid  (groupid  IN  VARCHAR), 
   MEMBER PROCEDURE set_groupseq (groupseq IN  INT), 
   MEMBER PROCEDURE clear_properties , 
   MEMBER PROCEDURE set_boolean_property( 
      property_name   IN      VARCHAR, 
      property_value  IN      BOOLEAN),  
   MEMBER PROCEDURE set_byte_property( 
      property_name   IN      VARCHAR, 
      property_value  IN      INT), 
   MEMBER PROCEDURE set_short_property( 
      property_name   IN      VARCHAR, 
      property_value  IN      INT), 
   MEMBER PROCEDURE set_int_property( 
      property_name   IN      VARCHAR, 
      property_value  IN      INT),
  MEMBER PROCEDURE set_long_property( 
     property_name   IN      VARCHAR, 
     property_value  IN      NUMBER), 
  MEMBER PROCEDURE set_float_property( 
     property_name   IN      VARCHAR, 
     property_value  IN      FLOAT), 
  MEMBER PROCEDURE set_double_property( 
     property_name   IN      VARCHAR, 
     property_value  IN      DOUBLE PRECISION),
  MEMBER PROCEDURE set_string_property( 
     property_name   IN      VARCHAR, 
     property_value  IN      VARCHAR), 
  MEMBER FUNCTION get_replyto  RETURN sys.aq$_agent, 
  MEMBER FUNCTION get_type     RETURN VARCHAR, 
  MEMBER FUNCTION get_userid   RETURN VARCHAR, 
  MEMBER FUNCTION get_appid    RETURN VARCHAR, 
  MEMBER FUNCTION get_groupid  RETURN VARCHAR, 
  MEMBER FUNCTION get_groupseq RETURN INT, 
  MEMBER FUNCTION get_boolean_property (property_name   IN   VARCHAR) 
    RETURN   BOOLEAN, 
  MEMBER FUNCTION get_byte_property    (property_name   IN   VARCHAR) 
    RETURN   INT, 
  MEMBER FUNCTION get_short_property   (property_name   IN   VARCHAR) 
    RETURN   INT, 
  MEMBER FUNCTION get_int_property     (property_name   IN   VARCHAR) 
    RETURN   INT, 
  MEMBER FUNCTION get_long_property    (property_name   IN   VARCHAR) 
    RETURN   NUMBER, 
  MEMBER FUNCTION get_float_property   (property_name   IN   VARCHAR) 
    RETURN   FLOAT, 
  MEMBER FUNCTION get_double_property  (property_name   IN   VARCHAR) 
    RETURN   DOUBLE PRECISION, 
  MEMBER FUNCTION get_string_property  (property_name   IN   VARCHAR) 
    RETURN   VARCHAR);

aq$_jms_text_message Type

This type is the ADT used to store a JMSText message in an AQ queue.

Syntax

TYPE aq$_jms_text_message AS object(
  header    aq$_jms_header,
  text_len  INT,
  text_vc   varchar2(4000),
  text_lob  clob,
  STATIC FUNCTION construct RETURN aq$_jms_text_message,
  MEMBER PROCEDURE set_text     (payload  IN  VARCHAR2),
  MEMBER PROCEDURE set_text     (payload  IN  CLOB),
  MEMBER PROCEDURE get_text     (payload  OUT VARCHAR2),
  MEMBER PROCEDURE get_text     (payload  OUT CLOB),
  MEMBER PROCEDURE set_replyto  (replyto  IN  sys.aq$_agent),
  MEMBER PROCEDURE set_type     (type     IN  VARCHAR),
  MEMBER PROCEDURE set_userid   (userid   IN  VARCHAR),
  MEMBER PROCEDURE set_appid    (appid    IN  VARCHAR),
  MEMBER PROCEDURE set_groupid  (groupid  IN  VARCHAR),
  MEMBER PROCEDURE set_groupseq (groupseq IN  INT),
  MEMBER PROCEDURE clear_properties,
  MEMBER PROCEDURE set_boolean_property(
     property_name   IN      VARCHAR,
     property_value  IN      BOOLEAN),
  MEMBER PROCEDURE set_byte_property (
     property_name   IN      VARCHAR,
     property_value  IN      INT ),
  MEMBER PROCEDURE set_short_property (
     property_name   IN      VARCHAR,
     property_value  IN      INT ),
  MEMBER PROCEDURE set_int_property (
     property_name   IN      VARCHAR,
     property_value  IN      INT ),
  MEMBER PROCEDURE set_long_property (
     property_name   IN      VARCHAR,
     property_value  IN      NUMBER ),
  MEMBER PROCEDURE set_float_property (
     property_name   IN      VARCHAR,
     property_value  IN      FLOAT ),
  MEMBER PROCEDURE set_double_property (
     property_name   IN      VARCHAR,
     property_value  IN      DOUBLE PRECISION ),
  MEMBER PROCEDURE set_string_property (
     property_name   IN      VARCHAR,
     property_value  IN      VARCHAR ),
  MEMBER FUNCTION get_replyto  RETURN sys.aq$_agent,
  MEMBER FUNCTION get_type     RETURN VARCHAR,
  MEMBER FUNCTION get_userid   RETURN VARCHAR,
  MEMBER FUNCTION get_appid    RETURN VARCHAR,
  MEMBER FUNCTION get_groupid  RETURN VARCHAR,
  MEMBER FUNCTION get_groupseq RETURN INT,
  MEMBER FUNCTION get_boolean_property (property_name IN  VARCHAR)
    RETURN   BOOLEAN,
  MEMBER FUNCTION get_byte_property   (property_name IN  VARCHAR)
    RETURN   INT,
  MEMBER FUNCTION get_short_property  (property_name IN  VARCHAR)
    RETURN   INT,
  MEMBER FUNCTION get_int_property    (property_name IN  VARCHAR)
    RETURN   INT,
  MEMBER FUNCTION get_long_property   (property_name IN  VARCHAR)
    RETURN   NUMBER,
  MEMBER FUNCTION get_float_property  (property_name IN  VARCHAR)
    RETURN   FLOAT,
  MEMBER FUNCTION get_double_property (property_name IN  VARCHAR)
    RETURN   DOUBLE PRECISION,
  MEMBER FUNCTION get_string_property (property_name IN  VARCHAR)
    RETURN   VARCHAR);

aq$_jms_bytes_message Type

This type is the ADT used to store a JMSBytes message in an AQ queue.

Syntax

TYPE aq$_jms_bytes_message AS object(
  header     aq$_jms_header,
  bytes_len  INT,
  bytes_raw  raw(2000),
  bytes_lob  blob,
  STATIC FUNCTION construct RETURN aq$_jms_bytes_message,
  MEMBER PROCEDURE set_bytes    (payload  IN RAW),
  MEMBER PROCEDURE set_bytes    (payload  IN BLOB),
  MEMBER PROCEDURE get_bytes    (payload  OUT RAW),
  MEMBER PROCEDURE get_bytes    (payload  OUT BLOB),
  MEMBER PROCEDURE set_replyto  (replyto  IN  sys.aq$_agent),
  MEMBER PROCEDURE set_type     (type     IN  VARCHAR),
  MEMBER PROCEDURE set_userid   (userid   IN  VARCHAR),
  MEMBER PROCEDURE set_appid    (appid    IN  VARCHAR),
  MEMBER PROCEDURE set_groupid  (groupid  IN  VARCHAR),
  MEMBER PROCEDURE set_groupseq (groupseq IN  INT),
  MEMBER PROCEDURE clear_properties,
  MEMBER PROCEDURE set_boolean_property(
     property_name   IN  VARCHAR,
     property_value  IN  BOOLEAN),
  MEMBER PROCEDURE set_byte_property(
     property_name   IN  VARCHAR,
     property_value  IN  INT),
  MEMBER PROCEDURE set_short_property(
     property_name   IN  VARCHAR,
                property_value  IN INT),
  MEMBER PROCEDURE set_int_property(
                property_name   IN VARCHAR,
                property_value  IN INT),
  MEMBER PROCEDURE set_long_property(
                property_name   IN VARCHAR,
                property_value  IN NUMBER),
  MEMBER PROCEDURE set_float_property(
                property_name   IN VARCHAR,
                property_value  IN FLOAT),
  MEMBER PROCEDURE set_double_property(
                property_name   IN VARCHAR,
                property_value  IN DOUBLE PRECISION),
  MEMBER PROCEDURE set_string_property(
                property_name   IN VARCHAR,
                property_value  IN VARCHAR),
  MEMBER FUNCTION get_replyto RETURN sys.aq$_agent,
  MEMBER FUNCTION get_type RETURN VARCHAR,
  MEMBER FUNCTION get_userid RETURN VARCHAR,
  MEMBER FUNCTION get_appid RETURN VARCHAR,
  MEMBER FUNCTION get_groupid RETURN VARCHAR,
  MEMBER FUNCTION get_groupseq RETURN INT,
  MEMBER FUNCTION get_boolean_property (property_name IN   VARCHAR)
    RETURN   BOOLEAN,
  MEMBER FUNCTION get_byte_property    (property_name IN   VARCHAR)
    RETURN   INT,
  MEMBER FUNCTION get_short_property   (property_name IN   VARCHAR)
    RETURN   INT,
  MEMBER FUNCTION get_int_property     (property_name IN   VARCHAR)
    RETURN   INT,
  MEMBER FUNCTION get_long_property    (property_name IN   VARCHAR)
    RETURN   NUMBER,
  MEMBER FUNCTION get_float_property   (property_name IN   VARCHAR)
    RETURN   FLOAT,
  MEMBER FUNCTION get_double_property  (property_name IN   VARCHAR)
    RETURN   DOUBLE PRECISION,
  MEMBER FUNCTION get_string_property  (property_name IN   VARCHAR)
    RETURN   VARCHAR);

Go to previous page Go to beginning of chapter Go to next page
Oracle
Copyright © 2000, 2002 Oracle Corporation.

All Rights Reserved.
Go To Documentation Library
Home
Go To Product List
Book List
Go To Table Of Contents
Contents
Go To Index
Index

Master Index

Feedback