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

Interface IMPConfigAdminIntrService

public interface IMPConfigAdminIntrService

IMPConfigAdminIntrService interface provides methods to create, remove and search SenderConfiguration (based on one or more interaction ids) along with associated SenderInteractionConfiguration(s) and SenderSideEffectConfiguration(s).

Method Summary

Modifier and Type	Method and Description
SenderConfiguration	createSenderConfiguration(SenderConfiguration senderConfiguration) Creates a new SenderConfiguration along with the zero ore more SenderInteractionConfiguration(s) and zero ore more SenderSideEffectConfiguration(s).
SenderConfiguration[]	findSenderConfiguration(SenderConfigSearchCriteria senderConfigSearchCriteria) The API returns an array of SenderConfiguration(s) matching the given Sender Id, Sender Id Extension, Receiver Id, and Receiver Id Extension specified in the SenderConfigSearchCriteria.
void	removeSenderConfiguration(SenderConfiguration senderConfiguration) Removes the SenderConfiguration along with all the associated SenderInteractionConfiguration(s) and SenderSideEffectConfiguration (s).

Method Detail

findSenderConfiguration

SenderConfiguration[] findSenderConfiguration(SenderConfigSearchCriteria senderConfigSearchCriteria)
                                       throws HDRConfigException

The API returns an array of SenderConfiguration(s) matching the given Sender Id, Sender Id Extension, Receiver Id, and Receiver Id Extension specified in the SenderConfigSearchCriteria. A SenderConfiguration may contain zero or more SenderInteractionConfiguration(s). A SenderInteractionConfiguration may contain zero or more SenderSideEffectConfiguration(s). If no matching SenderConfiguration is found for the SenderConfigSearchCriteria, then null value is returned.

Parameters:

senderConfigSearchCriteria - SenderConfigSearchCriteria object, with the following attributes set optionally,

• Sender Id
• Sender Extension
• Receiver Id
• Receiver Extension

Returns:

If no matching SenderConfiguration(s) found, then null value is returned. Else one ore more SenderConfiguration(s) returned.

Throws:

HDRConfigException - This Exception is thrown, if find operation fails.

createSenderConfiguration

SenderConfiguration createSenderConfiguration(SenderConfiguration senderConfiguration)
                                       throws HDRConfigException

Creates a new SenderConfiguration along with the zero ore more SenderInteractionConfiguration(s) and zero ore more SenderSideEffectConfiguration(s). The SenderConfiguration is uniquely identified by the combination of its Sender Id and Receiver Id. IMP uses this SenderConfiguration details for validating the Messages before processing.

Parameters:

senderConfiguration - The SenderConfiguration object, with zero or more SenderInteractionConfiguration(s) and with zero or more SenderSideEffectConfiguration(s).

Returns:

The newly created SenderConfiguration object.

Throws:

HDRConfigException - This exception is thrown if

• The combination of Receiver Id and Sender Id already present in database.
• The Receiver is not already configured in HDR.
• MasterCatalog Ids for SenderSideEffectConfiguration do not exist in database.
• If one or more Mastercatalog Id is null or invalid.
• SenderSideEffectConfiguration detail is duplicate.

removeSenderConfiguration

void removeSenderConfiguration(SenderConfiguration senderConfiguration)
                        throws HDRConfigException

Removes the SenderConfiguration along with all the associated SenderInteractionConfiguration(s) and SenderSideEffectConfiguration (s).
Removes SenderConfiguration from database, which exactly matches the input SenderConfiguration instance.
So, the user needs to invoke the finder API (findSenderConfiguration())first, to get the exact SenderConfiguration instance , and then pass the same instance to this API, for removal.

After removing the SenderConfiguration, Messages associated with the SenderConfiguration can not be processed by IMP.

Parameters:

senderConfiguration - The fully populated SenderConfiguration object.

Throws:

HDRConfigException - This exception is thrown, if

• SenderConfiguration is not found.
• Removal operation fails.