|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.candle.roma.kxc.RomaRetrieveOptions
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 |
public RomaRetrieveOptions()
Method Detail |
public void setCloseTheme(boolean flag)
flag
- if true then the theme will be closed.public void setRetainTheme(boolean flag)
flag
- if true then the theme is retained.public void setWaitIndefinite()
public void setUseTheme(boolean flag)
flag
- if true theme already associated with the
RomaMessage will be used. If false the new theme
allocation will be done.public void setAnyTheme(boolean flag)
flag
- if true the theme will be ignored
If false the theme will be matchedpublic void setApiProfileName(java.lang.String name)
name
- the name of the API profile.public void useApiProfile(boolean flag)
If this option is chosen but the specified profile is not available then default values are used for the put options.
flag
- :-
public void setErrorProfileName(java.lang.String name)
name
- the name of the error profile.public void setOperation(int op)
op
- the new message receive options. It is expected that
this will be one of the following values :-
public void setSelector(int sel)
sel
- the new message selection options.
It is expected that
this will be one of the following values :-
public void setTheme(RomaTheme theme)
theme
- the new theme.public void setMsgId(byte[] msgId)
msgId
- the new message identifier valuepublic void setCorrelId(byte[] correlId)
correlId
- the new correlation identifier value.public void setWaitInterval(int waitInterval)
waitInterval
- the new wait interval value in milliseconds.public void setWaitIndefinite(boolean flag)
flag
- true for indefinate waitpublic void setNoEms(boolean b)
flag
- :-
public void setNoNotification(boolean flag)
flag
- :-
public void setSyncpointDef(RomaSyncpointDef sync)
sync
- definition to be used.
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |