com.candle.roma.kxc
Class RomaThemeInfo

java.lang.Object
  |
  +--com.candle.roma.kxc.RomaThemeInfo
All Implemented Interfaces:
java.lang.Cloneable

public class RomaThemeInfo
extends java.lang.Object
implements java.lang.Cloneable

This class defines the theme details extracted with the RomaBusinessElement.queryTheme(RomaTheme) or RomaClient.queryTheme(RomaTheme) method.

See Also:
RomaWorkflow, RomaTrailer, RomaEteInfo

Constructor Summary
RomaThemeInfo()
          Constructs the empty object.
 
Method Summary
 java.lang.Object clone()
          Returns a copy of the object.
 int getConfirmFlags()
          Returns the confirmation flags.
 RomaEteInfo getEteInfo()
          Returns the end-to-end and in-flight information.
 int getRetryCount()
          Returns the retry count.
 byte[] getThemeId()
          Returns the theme ID.
 java.util.LinkedList getTrailers()
          Returns the persistent trailers.
 RomaWorkflow getWorkflow()
          Returns the associated workflow.
 void setConfirmFlags(int flags)
          Sets the confirmation flags.
 void setEteInfo(RomaEteInfo ete)
          Sets the end-to-end and in-flight information.
 void setRetryCount(int count)
          Sets the retry count.
 void setThemeId(byte[] id)
          Sets the theme ID.
 void setTrailers(java.util.Collection col)
          Sets the persistent trailers overwriting whatever persistent trailers already exist.
 void setWorkflow(RomaWorkflow wf)
          Sets the workflow.
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RomaThemeInfo

public RomaThemeInfo()
Constructs the empty object.
Method Detail

setWorkflow

public void setWorkflow(RomaWorkflow wf)
Sets the workflow.
Parameters:
wf - Workflow information

getWorkflow

public RomaWorkflow getWorkflow()
Returns the associated workflow.

setRetryCount

public void setRetryCount(int count)
Sets the retry count. Note that applications should enable the retry counter specifying true for the RomaBeResponse.setIncrementRetryCount(boolean) method on any subsequent put operation to prevent Roma from setting the retry count to 0.
Parameters:
count - Retry count

getRetryCount

public int getRetryCount()
Returns the retry count. This is the number of times the message has been sent to the exception message queue since the last successful put operation. For the first retrieval of a failed message, the retry count will be 0. If the put operation fails a second time and the message is again sent to the EMQ, the retry count will be 1. This lets your EMQ application know how many times a put attempt has failed, so it can choose to take different a action when the count reaches some threshold. Once a client or server operation succeeds, your EMQ application should turn the retry incrementation off so the retry count can be reset to 0. This can be done specifying false for the RomaBeResponse.setIncrementRetryCount(boolean) method.

setThemeId

public void setThemeId(byte[] id)
Sets the theme ID.
Parameters:
id - Theme ID

getThemeId

public byte[] getThemeId()
Returns the theme ID.

setConfirmFlags

public void setConfirmFlags(int flags)
Sets the confirmation flags.
Parameters:
flags - Confirmation flags. Should be zero or a combination of
  • Roma.CONFIRM_DELIVERY - confirmation of delivery
  • Roma.CONFIRM_ARRIVAL - confirmation of arrival

getConfirmFlags

public int getConfirmFlags()
Returns the confirmation flags.
Returns:
zero if the confirmation is disabled or a combination of
  • Roma.CONFIRM_DELIVERY - confirmation of delivery
  • Roma.CONFIRM_ARRIVAL - confirmation of arrival

setTrailers

public void setTrailers(java.util.Collection col)
Sets the persistent trailers overwriting whatever persistent trailers already exist.
Parameters:
col - Collection of RomaTrailer objects

getTrailers

public java.util.LinkedList getTrailers()
Returns the persistent trailers. The trailers are added to the message by various ILSs involved in the message transformation and delivery.
Returns:
List of RomaTrailer objects

setEteInfo

public void setEteInfo(RomaEteInfo ete)
Sets the end-to-end and in-flight information.
Parameters:
ete - End-to-end and in-flight information.

getEteInfo

public RomaEteInfo getEteInfo()
Returns the end-to-end and in-flight information.

clone

public java.lang.Object clone()
Returns a copy of the object.
Overrides:
clone in class java.lang.Object