com.candle.roma.kxc
Class RomaReportOptions

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

public class RomaReportOptions
extends java.lang.Object

This class contains the options that the application supplies when it invokes the Error Analysis Routine.


Constructor Summary
RomaReportOptions()
          Constructs a ReportOptions object with default attributes.
 
Method Summary
 void setDefaultActions(int defaultActions)
          Sets the default actions that should be carried out.
 void setErrorProfileName(java.lang.String errorProfileName)
          Sets the error profile name.
 void setNoAlert(boolean flag)
          Enable or disable the option to prevent alerts from being sent.
 void setNoEms(boolean flag)
          Enable or disable the option to put the message to the exception management service if the report error operation fails.
 void setNoNotification(boolean flag)
          Enable or disable the option to send a notification message to the client if the report error operation fails.
 void setNoTransformation(boolean b)
          Enable or disable the option to send an error profiling message to a transformation engine if the message type is not recognised.
 void setSyncpointDef(RomaSyncpointDef sync)
          Specify sync point definitiion
 void setTheme(RomaTheme theme)
          Sets the theme.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RomaReportOptions

public RomaReportOptions()
Constructs a ReportOptions object with default attributes.
Method Detail

setErrorProfileName

public void setErrorProfileName(java.lang.String errorProfileName)
Sets the error profile name.
Parameters:
errorProfileName - the new error profile name

setDefaultActions

public void setDefaultActions(int defaultActions)
Sets the default actions that should be carried out. This overrides the actions listed in the profile.
Parameters:
defaultActions - any combination of the following flags :-
  • ACTION_NOTIFY - send notification response
  • ACTION_EMS - put to exception message service
  • ACTION_ALERT - send alert
  • ACTION_LOG - write to log
  • ACTION_RESET - reset error
  • ACTION_NOACTION - take no action
  • ACTION_EMSRAW - put raw message to exception message service.

setNoEms

public void setNoEms(boolean flag)
Enable or disable the option to put the message to the exception management service if the report error operation fails.
Parameters:
flag - boolean selector.
  • true - disable put to the exception message service.
  • false - enable put to the exception message service.

setNoNotification

public void setNoNotification(boolean flag)
Enable or disable the option to send a notification message to the client if the report error operation fails.
Parameters:
flag - boolean selector.
  • true - disable the sending of a notification.
  • false - enable the sending of a notification.

setNoTransformation

public void setNoTransformation(boolean b)
Enable or disable the option to send an error profiling message to a transformation engine if the message type is not recognised.
Parameters:
flag - boolean selector.
  • true - prevent involvement of the transformation engine.
  • false - allow use of a transformation engine.

setNoAlert

public void setNoAlert(boolean flag)
Enable or disable the option to prevent alerts from being sent.
Parameters:
flag - boolean selector.
  • true - do not allow alerts to be sent.
  • false - allow alerts.

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.