oracle.hsgbu.hdr.message.submissionunit

Interface SubmissionUnitService

All Known Subinterfaces:

SubmissionUnitServiceLocalCMT, SubmissionUnitServiceRemoteCMT

public interface SubmissionUnitService

Defines methods for retrieving persisted SubmissionUnit objects.

Method Summary

Modifier and Type	Method and Description
SubmissionUnit	addSubmissionUnit(SubmissionUnit submissionUnit) Deprecated. Use createSubmissionUnit(SubmissionUnit).
SubmissionUnit	createSubmissionUnit(SubmissionUnit submissionUnit) Persists the SubmissionUnit object given as parameter.
SubmissionUnit	findSubmissionUnit(String messageId, String senderOID) Deprecated. Use findSubmissionUnitByMessage(II).
SubmissionUnit	findSubmissionUnitByControlAct(II controlActId) Finds the persisted SubmissionUnit object for the specified ControlAct.
SubmissionUnit	findSubmissionUnitById(String submissionUnitId) Finds the persisted SubmissionUnit object for the specified SubmissionUnit identifier.
SubmissionUnit	findSubmissionUnitByMessage(II messageId) Finds a persisted SubmissionUnit object for the specified message identifier.
SubmissionUnit	getSubmissionUnitById(String submissionUnitId) Deprecated. Use findSubmissionUnitById(String).
void	updateSubmissionUnit(SubmissionUnit submissionUnit) Updates the persisted SubmissionUnit object given as parameter.

Method Detail

findSubmissionUnitByMessage

SubmissionUnit findSubmissionUnitByMessage(II messageId)
                                    throws HDRRimException

Finds a persisted SubmissionUnit object for the specified message identifier.

Parameters:

messageId - Message identifier for the HDR-compliant HL7 version 3.0 message

Returns:

SubmissionUnit object that has the specified message identifier. It returns a null if no match is found.

Throws:

HDRRimException - If one of the II components is null.

findSubmissionUnit

SubmissionUnit findSubmissionUnit(String messageId,
                                  String senderOID)
                           throws HDRRimException

Deprecated. Use findSubmissionUnitByMessage(II).

Finds a persisted SubmissionUnit object for the specified message identifier and sender Object Identifier (OID) parameters.

Parameters:

messageId - String composed of a concatenation of three elements: The message identifier root (from II type identifier), a period ("."), and the message identifier extension.

senderOID - OID of the sender. This parameter is mandatory.

Returns:

SubmissionUnit object that has the specified message identifier and sender OID. It returns a null if no match is found.

Throws:

HDRRimException - If one of the String parameters is null.

findSubmissionUnitByControlAct

SubmissionUnit findSubmissionUnitByControlAct(II controlActId)
                                       throws HDRRimException

Finds the persisted SubmissionUnit object for the specified ControlAct.

Parameters:

controlActId - One of ControlAct II identifiers for the HDR-compliant HL7 version 3.0 message.

Returns:

SubmissionUnit associated with the specified ControlAct. It returns a null if no match is found.

Throws:

HDRRimException - If controlActId, or its root, or its extension is null.

findSubmissionUnitById

SubmissionUnit findSubmissionUnitById(String submissionUnitId)
                               throws HDRRimException

Finds the persisted SubmissionUnit object for the specified SubmissionUnit identifier.

Parameters:

submissionUnitId - Identifier of the SubmissionUnit object to be retrieved.

Returns:

SubmissionUnit that has the specified identifier. It returns a null if no match is found.

Throws:

HDRRimException - If:

• SubmissionUnitId is null
• SubmissionUnitId is not a valid number format

getSubmissionUnitById

SubmissionUnit getSubmissionUnitById(String submissionUnitId)
                              throws HDRRimException

Deprecated. Use findSubmissionUnitById(String).

Gets the persisted SubmissionUnit object for the identifier value given as parameter.

Parameters:

submissionUnitId - Identifier of the SubmissionUnit object to be retrieved.

Returns:

SubmissionUnit that has the specified identifier. It returns a null if no match is found.

Throws:

HDRRimException - If:

• SubmissionUnitId is null
• SubmissionUnitId is not a valid number format

createSubmissionUnit

SubmissionUnit createSubmissionUnit(SubmissionUnit submissionUnit)
                             throws HDRRimException

Persists the SubmissionUnit object given as parameter.

Parameters:

submissionUnit - The SubmissionUnit object to be persisted.

Returns:

The persisted SubmissionUnit object.

Throws:

HDRRimException - If any error occurs while persisting the SubmissionUnit.

addSubmissionUnit

SubmissionUnit addSubmissionUnit(SubmissionUnit submissionUnit)
                          throws HDRRimException

Deprecated. Use createSubmissionUnit(SubmissionUnit).

Persists the SubmissionUnit object given as parameter.

Parameters:

submissionUnit - The SubmissionUnit object to be persisted.

Returns:

The persisted SubmissionUnit object.

Throws:

HDRRimException - If any error is encountered persisting the SubmissionUnit.

updateSubmissionUnit

void updateSubmissionUnit(SubmissionUnit submissionUnit)
                   throws HDRRimException

Updates the persisted SubmissionUnit object given as parameter.

Parameters:

submissionUnit - The SubmissionUnit object to be updated.

Throws:

HDRRimException - If any error occurs while persisting the updated SubmissionUnit.