com.candle.roma.kxc
Class RomaExceptionOptions

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

public class RomaExceptionOptions
extends java.lang.Object

This class encapsulates the options when putting a RomaExceptionMessage on an Exception Message Queue.

See Also:
RomaExceptionMessage

Constructor Summary
RomaExceptionOptions()
          Constructs a new RomaExceptionOptions object with default options.
 
Method Summary
 void setApiProfileName(java.lang.String profile)
          Associates an API profile with the put operation.
 void setCloseTheme(boolean flag)
          Specify whether the theme should be closed automatically when the operation completes.
 void setErrorProfileName(java.lang.String profile)
          Associates an error profile with the put operation.
 void setIncrementRetryCount(boolean select)
          Enables or disables the option to reset the retry count when sending the message.
 void setNewTheme(boolean flag)
          Specify whether a new theme should be allocated.
 void setNoEms(boolean select)
          Enables or disables the option to send the message to an exception message service if the put operation fails.
 void setNoNotification(boolean select)
          Enables or disables the option to send a notification message back to the sender if the message get operation fails.
 void setNoSyncAllowed(boolean flag)
          Controls whether an MSMQ message can be placed outside syncpoint control.
 void setNoTransformation(boolean select)
          Enables or disables the option to send the message to a message transformation service if the next component in the workflow cannot accept the message format.
 void setRetainTheme(boolean flag)
          Specify whether the theme should be retained for future operations.
 void setSelector(int sel)
          Sets the put selector.
 void setServiceName(java.lang.String serviceName)
          The name of the Business Service that defines the exception message queue.
 void setSyncpointDef(RomaSyncpointDef sync)
          Specify sync point definitiion
 void setTermSupported(boolean flag)
          Specify if termination is supported
 void setTheme(RomaTheme theme)
          Sets the theme.
 void setUseApiProfile(boolean flag)
          Indicates that flags and options specified in the API profile should be used for the Roma put operation.
 void setUseTheme(boolean flag)
          Specify whether an existing theme should be used.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RomaExceptionOptions

public RomaExceptionOptions()
Constructs a new RomaExceptionOptions object with default options.
Method Detail

setServiceName

public void setServiceName(java.lang.String serviceName)
The name of the Business Service that defines the exception message queue. If this is set to be null, the name of the service is retrieved from the subnet stanza entry in the directory configuration.

setSelector

public void setSelector(int sel)
Sets the put selector. This specifies which identifiers contained in the message should be used when the message is put.
Parameters:
sel - the new value of the put selector.

The value will be one of the following fields :-

  • 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.

setErrorProfileName

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

setUseApiProfile

public void setUseApiProfile(boolean flag)
Indicates that flags and options specified in the API profile should be used for the Roma put operation.

If this option is chosen but the specified profile is not available then default values are used for the put options.


setIncrementRetryCount

public void setIncrementRetryCount(boolean select)
Enables or disables the option to reset the retry count when sending the message.
Parameters:
select - one of :-
  • true - do not increment the retry count when sending the message.
  • false - reset the retry count when sending the message.

setNoEms

public void setNoEms(boolean select)
Enables or disables the option to send the message to an exception message service if the put operation fails.
Parameters:
select - one of :-
  • true - do not perform a send to an exception message service if put fails.
  • false - allow a message to be sent to an exception message service if the put fails.

setNoNotification

public void setNoNotification(boolean select)
Enables or disables the option to send a notification message back to the sender if the message get operation fails.
Parameters:
select - one of :-
  • true - do allow a notification message to be sent.
  • false - do not allow a notification message to be sent on a get failure.

setNoTransformation

public void setNoTransformation(boolean select)
Enables or disables the option to send the message to a message transformation service if the next component in the workflow cannot accept the message format.
Parameters:
select - one of :-
  • true - do not allow the message to sent to the transformation service.
  • false - allow the message to be routed via a transformation service if necessary.

setTermSupported

public void setTermSupported(boolean flag)
Specify if termination is supported
Parameters:
flag - true to indicate termination is supported.

setNewTheme

public void setNewTheme(boolean flag)
Specify whether a new theme should be allocated.

Parameters:
flag - if true then a new theme is allocated.

setRetainTheme

public void setRetainTheme(boolean flag)
Specify whether the theme should be retained for future operations.

Parameters:
flag - if true then the theme is retained.

setCloseTheme

public void setCloseTheme(boolean flag)
Specify whether the theme should be closed automatically when the operation completes.

Parameters:
flag - if true then the theme will be closed.

setUseTheme

public void setUseTheme(boolean flag)
Specify whether an existing theme should be used.

Parameters:
flag - if true then the existing theme is used.

setSyncpointDef

public void setSyncpointDef(RomaSyncpointDef sync)
Specify sync point definitiion

Parameters:
sync - definition to be used.

setTheme

public void setTheme(RomaTheme theme)
Sets the theme.
Parameters:
theme - the new theme.