oracle.ifs.adk.queue
Class IfsQueueMessage

java.lang.Object
  |
  +--oracle.ifs.adk.queue.IfsQueueMessage

All Implemented Interfaces:

oracle.jdbc.internal.ObjectData, oracle.jdbc.internal.ObjectDataFactory, oracle.sql.ORAData, oracle.sql.ORADataFactory

public class IfsQueueMessage

extends java.lang.Object

implements oracle.sql.ORADataFactory, oracle.sql.ORAData

IfsQueueMessage class is the java representation for payloads on the queues IFS_IN and IFS_OUT. This class is used to build, enqueue, dequeue and process messages from java.

Constructor Summary

IfsQueueMessage()
Default constructor.

IfsQueueMessage(java.lang.String type, java.lang.Object[] list)
Constructor that takes parameters.

Method Summary

oracle.sql.ORAData	create(oracle.sql.Datum d, int sqlType) Implements the create method of ORADataFactory interface.
static oracle.sql.ORADataFactory	getFactory() This implements the ORADataFactory interface.
java.util.Hashtable	getHashtableOfParameters() Returns hashtable of parameters in the message.
java.lang.String	getMessageType() Get the message type of the message.
java.lang.Object[]	getParameterList() Returns the list of parameters for the message.
void	setMessageType(java.lang.String messageType) Sets the message type.
void	setParameterList(java.lang.Object[] list) Sets the parameter list on the message.
oracle.sql.Datum	toDatum(java.sql.Connection c) Implements the toDatum method.

Constructor Detail

IfsQueueMessage

public IfsQueueMessage()

Default constructor.

IfsQueueMessage

public IfsQueueMessage(java.lang.String type,
                       java.lang.Object[] list)

Constructor that takes parameters.

Parameters:

type - type of the message

list - parameter list of the message

Throws:

IfsException - if the construction fails

Method Detail

getFactory

public static oracle.sql.ORADataFactory getFactory()

This implements the ORADataFactory interface.

toDatum

public oracle.sql.Datum toDatum(java.sql.Connection c)
                         throws java.sql.SQLException

Implements the toDatum method.

Specified by:

toDatum in interface oracle.sql.ORAData

Parameters:

connection - handle to the database connection

Returns:

Datum

Throws:

java.sql.SQLException - if the operation fails

create

public oracle.sql.ORAData create(oracle.sql.Datum d,
                                 int sqlType)
                          throws java.sql.SQLException

Implements the create method of ORADataFactory interface.

Specified by:

create in interface oracle.sql.ORADataFactory

Parameters:

d - datum

sqlType - sql type

Returns:

ORAData

Throws:

java.sql.SQLException - if the operation fails

getMessageType

public java.lang.String getMessageType()
                                throws IfsException

Get the message type of the message.

Returns:

message type

Throws:

IfsException - if the operation fails

setMessageType

public void setMessageType(java.lang.String messageType)
                    throws IfsException

Sets the message type.

Parameters:

messageType - type of the message

getParameterList

public java.lang.Object[] getParameterList()
                                    throws IfsException

Returns the list of parameters for the message.

Returns:

array of objects

Throws:

IfsException - if the operation fails

setParameterList

public void setParameterList(java.lang.Object[] list)
                      throws IfsException

Sets the parameter list on the message.

Parameters:

list - array of parameter objects

Throws:

IfsException - if the operation fails.

getHashtableOfParameters

public java.util.Hashtable getHashtableOfParameters()
                                             throws IfsException

Returns hashtable of parameters in the message.

Returns:

Hashtable of parameters

Throws:

IfsException - if the operation fails