com.candle.roma.kxc
Class RomaBeRequest

java.lang.Object
  |
  +--com.candle.roma.kxc.RomaBeRequest

public class RomaBeRequest
extends java.lang.Object

This class encapsulates requests received by Roma Business Elements.

It provides a framework for converting the message request data to structured application-specific response data.

It is intended that a RomaBeRequest subclass provide an implementation for the application-specific unmarshalling of request data following a client request.


Constructor Summary
RomaBeRequest()
           
RomaBeRequest(RomaBeRequest request)
           
 
Method Summary
 int backoutCount()
          Return the backout count.
 int codepage()
          Return the message codepage.
 byte[] correlId()
          Return the message correlation identifier.
 int encoding()
          Return the encoding.
 int expiry()
          Return the message expiry time in seconds.
 int feedback()
          Get the message feedback code.
 int format()
          Return the message format.
 java.lang.String formatName()
          Return the message format name.
 RomaILSData getILSData()
          Get incoming ILS data
 byte[] msgBuffer()
          Return message data buffer.
 int msgDataLength()
          Return message data buffer length.
 byte[] msgId()
          Return the message identifier in a byte array.
 java.lang.String msgName()
          Returns name of message
 int msgType()
          Return the message type.
 int persistence()
          Return the persistence.
 int priority()
          Return the message priority.
 int status()
          Return the message status.
 byte[] tagBuffer()
          Return message tag buffer.
 int tagDataLength()
          Return message data buffer length.
 RomaTheme theme()
          Return the message theme.
 java.util.Date timeStamp()
          Returns the time stamp which, for get operations, is the time at which the put operation occurred.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RomaBeRequest

public RomaBeRequest()

RomaBeRequest

public RomaBeRequest(RomaBeRequest request)
Method Detail

msgType

public int msgType()
Return the message type. This can be one of the following :- Note that these are values returned to indicate the type of an incoming message. An application cannot set the message type in order to create a specific type of message. The type of an outgoing message is defined implicitly by the options selected when the message is sent.

priority

public int priority()
Return the message priority.

persistence

public int persistence()
Return the persistence. This can be one of the following :-

format

public int format()
Return the message format.

feedback

public int feedback()
Get the message feedback code.

expiry

public int expiry()
Return the message expiry time in seconds.

codepage

public int codepage()
Return the message codepage.

encoding

public int encoding()
Return the encoding. This can be one of the following :-

msgId

public byte[] msgId()
Return the message identifier in a byte array.

correlId

public byte[] correlId()
Return the message correlation identifier.

msgBuffer

public byte[] msgBuffer()
Return message data buffer.

msgDataLength

public int msgDataLength()
Return message data buffer length.

tagBuffer

public byte[] tagBuffer()
Return message tag buffer.

tagDataLength

public int tagDataLength()
Return message data buffer length.

status

public int status()
Return the message status. This can be one of the following :-

backoutCount

public int backoutCount()
Return the backout count. This is the number of times that the message has been rolled back.

formatName

public java.lang.String formatName()
Return the message format name.

timeStamp

public java.util.Date timeStamp()
Returns the time stamp which, for get operations, is the time at which the put operation occurred.

theme

public RomaTheme theme()
Return the message theme. Theme can be set internally when the message is being sent or received or else explicitly by the user.

msgName

public java.lang.String msgName()
Returns name of message

getILSData

public RomaILSData getILSData()
Get incoming ILS data