com.candle.roma.kxc
Class RomaStoreOptions

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

public class RomaStoreOptions
extends java.lang.Object

This class encapsulates the options available when storing a message to a storage queue.


Constructor Summary
RomaStoreOptions()
          Constructs a new instance with store options initialised to the default.
 
Method Summary
 void setApiProfileName(java.lang.String profile)
          Associates an API profile with the put operation.
 void setCloseTheme(boolean flag)
          Selects whether of not the theme is to be closed or retained in the put operation.
 void setNewTheme(boolean flag)
          Selects whether or not a new theme will be allocated when applying these options.
 void setNoSyncAllowed(boolean flag)
          Controls whether an MSMQ message can be placed outside syncpoint control.
 void setRetainTheme(boolean flag)
          Selects whether or not the theme is to be closed or else retained in the put operation.
 void setSelector(int sel)
          Sets the put selector.
 void setSyncpointDef(RomaSyncpointDef sync)
          Specify sync point definitiion
 void setUseTheme(boolean flag)
          Selects whether or not a new theme will be allocated when applying these options
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RomaStoreOptions

public RomaStoreOptions()
Constructs a new instance with store options initialised to the default.
Method Detail

setSelector

public void setSelector(int sel)
Sets the put selector.
Parameters:
sel - the new value of the put selector, one of :-
  • USE_NONE
  • USE_MSGID
  • USE_CORRELID
  • USE_MSGID_AND_CORRELID

setNoSyncAllowed

public void setNoSyncAllowed(boolean flag)
Controls whether an MSMQ message can be placed outside syncpoint control. If the application attempts to put a message to MSMQ inside syncpoint control but the target queue does not support transactions, the call is normally rejected with error code RC_NONXACTIONAL. The application can call this method with true flag to force an MSMQ message to be placed outside syncpoint control.
Parameters:
flag - one of :-
  • true - allow MSMQ messages to be placed outside syncpoint control
  • false - don't allow MSMQ messages to be placed outside syncpoint control

setApiProfileName

public void setApiProfileName(java.lang.String profile)
Associates an API profile with the put operation.
Parameters:
profile - the name of the API profile.

setNewTheme

public void setNewTheme(boolean flag)
Selects whether or not a new theme will be allocated when applying these options.
Parameters:
flag - if true then new theme allocation is enabled, otherwise it is disabled. If disabled, the theme already associated with the RomaMessage will be used.

setUseTheme

public void setUseTheme(boolean flag)
Selects whether or not a new theme will be allocated when applying these options
Parameters:
flag - if true theme already associated with the RomaMessage will be used. If false the new theme allocation will be done.

setRetainTheme

public void setRetainTheme(boolean flag)
Selects whether or not the theme is to be closed or else retained in the put operation.
Parameters:
flag - if true then new retain the theme. Otherwise close the theme.

setCloseTheme

public void setCloseTheme(boolean flag)
Selects whether of not the theme is to be closed or retained in the put operation.
Parameters:
flag - if true close the theme otherwise retain the theme

setSyncpointDef

public void setSyncpointDef(RomaSyncpointDef sync)
Specify sync point definitiion

Parameters:
sync - definition to be used.