oracle.odi.interfaces.data
Class IJMSCallBack.CallBackResult

java.lang.Object
  oracle.odi.interfaces.data.IJMSCallBack.CallBackResult

Enclosing interface:

IJMSCallBack

public static class IJMSCallBack.CallBackResult
extends java.lang.Object

An inner class used to return the result status when processing a JMS request.

Constructor Summary

IJMSCallBack.CallBackResult()
A simple constructor.

IJMSCallBack.CallBackResult(java.lang.String pClientID, java.lang.String pMessageSelector, java.lang.String pMessageMaxNumber, java.lang.String pMessageTimeOut, java.lang.String pNextMessageTimeOut, java.lang.String pDurable)
A constructor that takes the stored message processing information as passed-in parameters.

Method Summary

java.lang.String	getClientID() Get the client id for the subscriber or queue receiver used to recieve the message.
java.lang.String	getDurable() Return true if the JMS subscriber used to receive the message is a durable subscriber.
java.lang.String	getMessageMaxNumber() Get the maximum number of JMS messages that can be simultaneously assigned to a server session in a JMS server session pool in a JMS ConnectionConsumer instance.
java.lang.String	getMessageSelector() Get the JMS message selector used by the receiver to filter the messages.
java.lang.String	getMessageTimeOut() Get the JMS message timeout value used when retrieving the JMS message.
java.lang.String	getNextMessageTimeOut() Get the JMS timeout that will be used when receiving the next message.
boolean	isFillJMS() If true, this result class has been populated with information from a valid JMS request.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IJMSCallBack.CallBackResult

public IJMSCallBack.CallBackResult()

A simple constructor.

IJMSCallBack.CallBackResult

public IJMSCallBack.CallBackResult(java.lang.String pClientID,
                                   java.lang.String pMessageSelector,
                                   java.lang.String pMessageMaxNumber,
                                   java.lang.String pMessageTimeOut,
                                   java.lang.String pNextMessageTimeOut,
                                   java.lang.String pDurable)

A constructor that takes the stored message processing information as passed-in parameters.

Parameters:

pClientID - the client id string

pMessageSelector - the message selector

pMessageMaxNumber - the maximum number of simultaneous message allowed.

pMessageTimeOut - the timeout value in milliseconds

pNextMessageTimeOut - the timeout value for the next message in milliseconds

pDurable - true if the subscriber is a durable subscriber, false otherwise.

Method Detail

getClientID

public java.lang.String getClientID()

Get the client id for the subscriber or queue receiver used to recieve the message.

Returns:

the client id string.

getDurable

public java.lang.String getDurable()

Return true if the JMS subscriber used to receive the message is a durable subscriber.

Returns:

True if the subscriber is a durable subscriber.

getMessageMaxNumber

public java.lang.String getMessageMaxNumber()

Get the maximum number of JMS messages that can be simultaneously assigned to a server session in a JMS server session pool in a JMS ConnectionConsumer instance.

Returns:

The maximum number of simultaneous messages allowed.

getMessageSelector

public java.lang.String getMessageSelector()

Get the JMS message selector used by the receiver to filter the messages.

Returns:

The message selector.

getMessageTimeOut

public java.lang.String getMessageTimeOut()

Get the JMS message timeout value used when retrieving the JMS message.

Returns:

The timeout value in milliseconds.

getNextMessageTimeOut

public java.lang.String getNextMessageTimeOut()

Get the JMS timeout that will be used when receiving the next message.

Returns:

The timeout value for the next message, in milliseconds.

isFillJMS

public boolean isFillJMS()

If true, this result class has been populated with information from a valid JMS request.

Returns:

True if this instance contains JMS request processing information.