oracle.hsgbu.hdr.message.improcessor.hl7.configuration.interaction

Interface SenderSideEffectConfiguration

All Superinterfaces:

Serializable

public interface SenderSideEffectConfiguration
extends Serializable

SideEffectConfiguration contains flags (options) to create or update RIM objects for a particular Message Type. A SideEffectConfiguration is uniquely identified by the combination of Sender Id, Receiver Id, Interaction Id, MasterCatalog Id associated with it.

The following SideEffectConfiguration options are available:

• CREATE_IF - If the RIM object does not exist already, then it is created. If it already exists, then it is not overlaid (no action is taken).
• OVERLAY - Overlays the existing RIM object. If the RIM object does not exist already, then exception will be thrown.
• CREATE_OR_OVERLAY - If the RIM Object does not exist already, then it is created. If it already exists, then it is overlaid.
• MUST_EXIST - The RIM object must exist already. If it does not exist, then exception will be thrown.
• CREATE_OR_UPDATE - If the RIM object does not exist, then it is created. If it already exists, then it is updated.
• UPDATE - If the RIM object exists, it is updated. If the RIM object does not exist, then exception will be thrown.

SenderSideEffectConfiguration contains the following attributes:

• MasterCatalog Id - The MasterCatalog Id for the RIM object.( MasterCatalog Id records should be already present in database).
• SenderInteractionId - SenderInteractionId associated with this SenderSideEffectConfiguration.
• ObjectRefModifierCode - Side Effect Reference Modifier for the RIM object.
• PlayerRefModifierCode - Side Effect Reference Modifier for the Player object.
• ScoperRefModifierCode - Side Effect Reference Modifier for the Scoper object.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CREATE_IF CREATE_IF - When this flag is set, If the RIM object does not exist already, then it is created. If it already exists, then it is not overlaid (no action is taken).
static String	CREATE_OR_OVERLAY CREATE_OR_OVERLAY - When this flag is set, If the RIM Object does not exist already, then it is created. If RIM object already exists, then it is overlaid.
static String	CREATE_OR_UPDATE CREATE_OR_UPDATE - When this flag is set, If the RIM object does not exist, then it is created. If it already exists, then it is updated.
static String	MUST_EXIST MUST_EXIST - When this flag is set, RIM object must exist already.
static String	OVERLAY OVERLAY - When this flag is set, Existing RIM object is overlaid. If the RIM object does not exist already, then exception will be thrown.
static String	UPDATE UPDATE - When this flag is set, If the RIM object exists, it is updated. If the RIM object does not exist, then exception will be thrown.

Method Summary

Modifier and Type	Method and Description
String	getMasterCatalogId() Returns the MasterCatalog Id of the RIM object, associated with this SideEffectConfiguration.
String	getObjectRefModifierCode() Returns the Object Reference Modifier Code for this SideEffectConfiguration.
String	getPlayerRefModifierCode() Returns the Player Reference Modifier Code for this SideEffectConfiguration.
String	getScoperRefModifierCode() Returns the Scoper Reference Modifier Code for this SideEffectConfiguration.
String	getSenderInteractionId() Returns the Sender Interaction Id associated with this SideEffectConfiguration.
void	setMasterCatalogId(String value) Sets the MasterCatalog Id of the RIM object, associated with this SideEffectConfiguration.
void	setObjectRefModifierCode(String value) Sets the Object Reference Modifier Code for this SideEffectConfiguration.
void	setPlayerRefModifierCode(String value) Sets the Player Reference Modifier Code for this SideEffectConfiguration.
void	setScoperRefModifierCode(String value) Sets the Scoper Reference Modifier Code for this SideEffectConfiguration.
void	setSenderInteractionId(String value) Sets the Sender Interaction Id associated with this SideEffectConfiguration.

Field Detail

CREATE_IF

static final String CREATE_IF

CREATE_IF - When this flag is set,

• If the RIM object does not exist already, then it is created.
• If it already exists, then it is not overlaid (no action is taken).

See Also:

Constant Field Values

OVERLAY

static final String OVERLAY

OVERLAY - When this flag is set,

• Existing RIM object is overlaid.
• If the RIM object does not exist already, then exception will be thrown.

See Also:

Constant Field Values

CREATE_OR_OVERLAY

static final String CREATE_OR_OVERLAY

CREATE_OR_OVERLAY - When this flag is set,

• If the RIM Object does not exist already, then it is created.
• If RIM object already exists, then it is overlaid.

See Also:

Constant Field Values

MUST_EXIST

static final String MUST_EXIST

MUST_EXIST - When this flag is set,

• RIM object must exist already. If it does not exist, then exception will be thrown.

See Also:

Constant Field Values

UPDATE

static final String UPDATE

UPDATE - When this flag is set,

• If the RIM object exists, it is updated.
• If the RIM object does not exist, then exception will be thrown.

See Also:

Constant Field Values

CREATE_OR_UPDATE

static final String CREATE_OR_UPDATE

CREATE_OR_UPDATE - When this flag is set,

• If the RIM object does not exist, then it is created.
• If it already exists, then it is updated.

See Also:

Constant Field Values

Method Detail

getMasterCatalogId

String getMasterCatalogId()

Returns the MasterCatalog Id of the RIM object, associated with this SideEffectConfiguration.

setMasterCatalogId

void setMasterCatalogId(String value)

Sets the MasterCatalog Id of the RIM object, associated with this SideEffectConfiguration.

getSenderInteractionId

String getSenderInteractionId()

Returns the Sender Interaction Id associated with this SideEffectConfiguration.

setSenderInteractionId

void setSenderInteractionId(String value)

Sets the Sender Interaction Id associated with this SideEffectConfiguration.

getObjectRefModifierCode

String getObjectRefModifierCode()

Returns the Object Reference Modifier Code for this SideEffectConfiguration.

setObjectRefModifierCode

void setObjectRefModifierCode(String value)

Sets the Object Reference Modifier Code for this SideEffectConfiguration.

getPlayerRefModifierCode

String getPlayerRefModifierCode()

Returns the Player Reference Modifier Code for this SideEffectConfiguration.

setPlayerRefModifierCode

void setPlayerRefModifierCode(String value)

Sets the Player Reference Modifier Code for this SideEffectConfiguration.

getScoperRefModifierCode

String getScoperRefModifierCode()

Returns the Scoper Reference Modifier Code for this SideEffectConfiguration.

setScoperRefModifierCode

void setScoperRefModifierCode(String value)

Sets the Scoper Reference Modifier Code for this SideEffectConfiguration.