com.candle.roma.kxc
Class RomaRetrieveOptions

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

public class RomaRetrieveOptions
extends java.lang.Object

The RomaRetrieveOptions encapsulates the options available when retrieving a message from a storage queue.


Constructor Summary
RomaRetrieveOptions()
          Construct a new RomaRetrieveOptions with default options.
 
Method Summary
 void setAnyTheme(boolean flag)
          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 flag)
          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 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 flag)
          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 flag)
          Specify whether the theme should be retained for future operations.
 void setSelector(int sel)
          Sets the message selection criteria.
 void setSyncpointDef(RomaSyncpointDef sync)
          Specify sync point definitiion
 void setTheme(RomaTheme theme)
          Sets the theme.
 void setUseTheme(boolean flag)
          Selects whether or not a new theme will be allocated when applying these options
 void setWaitIndefinite()
          Sets an indefinite wait interval.
 void setWaitIndefinite(boolean flag)
          Sets whether to wait without timing out
 void setWaitInterval(int waitInterval)
          Sets the wait interval in milliseconds.
 void useApiProfile(boolean flag)
          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

RomaRetrieveOptions

public RomaRetrieveOptions()
Construct a new RomaRetrieveOptions with default options.
Method Detail

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.

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.

setWaitIndefinite

public void setWaitIndefinite()
Sets an indefinite wait interval.

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.

setAnyTheme

public void setAnyTheme(boolean flag)
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

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

Parameters:
flag - :-
  • true - use API profile
  • false - do not use API profile

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 indefinate 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.
Parameters:
flag - :-
  • true - no message to be sent to the Exception Queue upon get failure
  • false - message to be sent

setNoNotification

public void setNoNotification(boolean flag)
Specify if a notification message is to be sent to the original sender if the get failed.
Parameters:
flag - :-
  • true - no message to be sent to the sender upon get failure
  • false - message to be sent to the sender

setSyncpointDef

public void setSyncpointDef(RomaSyncpointDef sync)
Specify sync point definitiion

Parameters:
sync - definition to be used.