com.candle.roma.kxc
Class RomaGetOptions

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

public class RomaGetOptions
extends java.lang.Object

The RomaGetOptions class encapsulates the criteria by which a Business Element retrieves a Client request or a Client retrieves a Business Service response.


Constructor Summary
RomaGetOptions()
          Constructs a new RomaGetOptions object with default options.
RomaGetOptions(RomaClientRequest rc)
          Constructs a new RomaGetOptions object initialising the theme, message id and correlation id from the supplied RomaClientRequest
 
Method Summary
 void allowNative(boolean b)
          Enables or disables the option to retrieve native (ie, non-Roma) messages.
 void setAnyTheme(boolean b)
          Selects whether not to get message by matching theme when applying these options
 void setApiProfileName(java.lang.String name)
          Sets the API profile name.
 void setCloseTheme(boolean b)
          Specify whether the theme should be closed automatically when the operation completes.
 void setCorrelId(byte[] correlId)
          Sets the correlation identifier.
 void setErrorProfileName(java.lang.String name)
          Sets the error profile name.
 void setILSData(RomaILSData ilsData)
          Set outgoing ILS data
 void setMsgId(byte[] msgId)
          Sets the message identifier.
 void setNoEms(boolean b)
          Specifies whether or not a get failure is to result in a message send to the Exception Message Queue.
 void setNoNotification(boolean b)
          Specify if a notification message is to be sent to the original sender if the get failed.
 void setOperation(int op)
          Set only the receive options of the object.
 void setRetainTheme(boolean b)
          Specify whether the theme should be retained for future operations.
 void setSecurityDef(RomaSecurityDef secDef)
          Sets the security definition.
 void setSelector(int sel)
          Sets the message selection criteria.
 void setSubjectStyle(int style)
          Sets the subject style for any receiving publications
 void setSuppressErrorProfile(boolean b)
          Specify if error profiling is to be suppressed
 void setSyncpointDef(RomaSyncpointDef sync)
          Specify sync point definitiion
 void setTermSupported(boolean b)
          Specify if termination is supported
 void setTheme(RomaTheme theme)
          Sets the theme.
 void setThemeControl(int control)
          Sets the theme.
 void setUseTheme(boolean b)
          Selects whether or not a new theme will be allocated when applying these options
 void setWaitIndefinite(boolean flag)
          Sets whether to wait without timing out
 void setWaitInterval(int waitInterval)
          Sets the wait interval in milliseconds.
 void useApiProfile(boolean b)
          Indicates that flags and options specified in the API profile should be used for the Roma put operation.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RomaGetOptions

public RomaGetOptions()
Constructs a new RomaGetOptions object with default options.

RomaGetOptions

public RomaGetOptions(RomaClientRequest rc)
Constructs a new RomaGetOptions object initialising the theme, message id and correlation id from the supplied RomaClientRequest
Parameters:
RomaClientRequest -  
Method Detail

allowNative

public void allowNative(boolean b)
Enables or disables the option to retrieve native (ie, non-Roma) messages.

Parameters:
select - one of :-
  • true - allow native messages.
  • false - disallow native messages.

setTermSupported

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

setSuppressErrorProfile

public void setSuppressErrorProfile(boolean b)
Specify if error profiling is to be suppressed
Parameters:
b - true to suppress error profiling

setSecurityDef

public void setSecurityDef(RomaSecurityDef secDef)
Sets the security definition. Subsequent get() operations will pass this to Roma inline services.
Parameters:
sec - new security definition. May be null.
See Also:
RomaSecurityDef

setILSData

public void setILSData(RomaILSData ilsData)
Set outgoing ILS data
Parameters:
ilsData - The ILS data to be sent with message

setThemeControl

public void setThemeControl(int control)
Sets the theme.
Parameters:
control - new theme control value, one of :-
  • THEME_RETAIN
  • THEME_CLOSE

setSubjectStyle

public void setSubjectStyle(int style)
Sets the subject style for any receiving publications
Parameters:
style - the style to be used, one of :-
  • STYLE_ROMA
  • STYLE_MQSERIES
  • STYLE_TIBRENDEZVOUS

setUseTheme

public void setUseTheme(boolean b)
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.

setAnyTheme

public void setAnyTheme(boolean b)
Selects whether not to get message by matching theme when applying these options
Parameters:
flag - if true the theme will be ignored if false the theme will be matched

setCloseTheme

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

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

setRetainTheme

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

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

setApiProfileName

public void setApiProfileName(java.lang.String name)
Sets the API profile name.
Parameters:
name - the name of the API profile.

useApiProfile

public void useApiProfile(boolean b)
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.


setErrorProfileName

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

setOperation

public void setOperation(int op)
Set only the receive options of the object.
Parameters:
op - the new message receive options. It is expected that this will be one of the following values :-
  • GET_FIRST
  • PEEK_FIRST
  • PEEK_NEXT
  • PEEK_SAME
  • GET_PEEKED

setSelector

public void setSelector(int sel)
Sets the message selection criteria.
Parameters:
sel - the new message selection options. It is expected that this will be one of the following values :-
  • BY_NONE
  • BY_THEME
  • BY_MSGID
  • BY_CORRELID
  • BY_MSGID_AND_CORRELID
  • BY_MSGID_AND_THEME

setTheme

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

setMsgId

public void setMsgId(byte[] msgId)
Sets the message identifier.
Parameters:
msgId - the new message identifier value

setCorrelId

public void setCorrelId(byte[] correlId)
Sets the correlation identifier.
Parameters:
correlId - the new correlation identifier value.

setWaitInterval

public void setWaitInterval(int waitInterval)
Sets the wait interval in milliseconds.
Parameters:
waitInterval - the new wait interval value in milliseconds.

setWaitIndefinite

public void setWaitIndefinite(boolean flag)
Sets whether to wait without timing out
Parameters:
flag - true for indefinite wait

setNoEms

public void setNoEms(boolean b)
Specifies whether or not a get failure is to result in a message send to the Exception Message Queue.

If an API profile is to be used ( selected by invoking the useApiProfile() method and verifiable by querying the isApiProfileUsed() method ) then this setting will be overridden either by the profile or, if not found, the default for this option.

Parameters:
b - true if no message should be sent to the Exception Message Queue upon a get operation failure.

setNoNotification

public void setNoNotification(boolean b)
Specify if a notification message is to be sent to the original sender if the get failed.

If an API profile is to be used ( selected by invoking the useApiProfile() method and verifiable by querying the isApiProfileUsed() method ) then this setting will be overridden either by the profile or, if not found, the default for this option.

Parameters:
b - true if no message should be sent to the sender upon a get operation failure.

setSyncpointDef

public void setSyncpointDef(RomaSyncpointDef sync)
Specify sync point definitiion

Parameters:
sync - definition to be used.