|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.candle.roma.kxc.RomaGetOptions
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 |
public RomaGetOptions()
public RomaGetOptions(RomaClientRequest rc)
RomaClientRequest
- Method Detail |
public void allowNative(boolean b)
select
- one of :-
public void setTermSupported(boolean b)
b
- true to indicate termination is supported.public void setSuppressErrorProfile(boolean b)
b
- true to suppress error profilingpublic void setSecurityDef(RomaSecurityDef secDef)
sec
- new security definition. May be null.RomaSecurityDef
public void setILSData(RomaILSData ilsData)
ilsData
- The ILS data to be sent with messagepublic void setThemeControl(int control)
control
- new theme control value, one of :-
public void setSubjectStyle(int style)
style
- the style to be used, one of :-
public void setUseTheme(boolean b)
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 b)
flag
- if true the theme will be ignored
if false the theme will be matchedpublic void setCloseTheme(boolean b)
b
- if true then the theme will be closed.public void setRetainTheme(boolean b)
b
- if true then the theme is retained.public void setApiProfileName(java.lang.String name)
name
- the name of the API profile.public void useApiProfile(boolean b)
If this option is chosen but the specified profile is not available then default values are used for the put options.
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 indefinite waitpublic void setNoEms(boolean b)
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.
b
- true if no message should be sent to the Exception
Message Queue upon a get operation failure.public void setNoNotification(boolean b)
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.
b
- true if no message should be sent to the sender
upon a get operation failure.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 |