au.gov.nehta.vendorlibrary.mdm.segments
Class MSH

java.lang.Object
  extended by au.gov.nehta.vendorlibrary.mdm.segments.MSH

public final class MSH
extends java.lang.Object

MSH Encapsulates MDM message header.


Nested Class Summary
static class MSH.Builder
          MSH.Builder Build class used to construct and validate an (@link MSH} object.
 
Method Summary
 AcknowledgementType getAcceptAcknowledgementType()
          Retrieve accept acknowledgement type.
 AcknowledgementType getApplicationAcknowledgementType()
          Retrieve application acknowledgement type.
 CountryCode getCountryCode()
          Retrieve country code.
 java.lang.String getEncodingCharacters()
          Retrieve encoding characters.
 java.lang.String getMessageControlId()
          Retrieve message control ID.
 java.util.Date getMessageDateTime()
          Retrieve message date/time.
 java.lang.String getMessageType()
          Retrieve message type.
 ProcessingId getProcessingId()
          Retrieve processing ID.
 HD getReceivingApplication()
          Retrieve receiving application.
 HD getReceivingFacility()
          Retrieve receiving facility.
 HD getSendingApplication()
          Retrieve sending application.
 HD getSendingFacility()
          Retrieve sending facility.
 java.lang.String getVersionId()
          Retrieve version ID.
static MSH parse(java.lang.String parseValue)
          Parse MSH segment from string.
 java.lang.String toString()
          Outputs a formatted MSH segment.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Method Detail

getEncodingCharacters

public java.lang.String getEncodingCharacters()
Retrieve encoding characters.

Returns:
Encoding characters string.

getSendingApplication

public HD getSendingApplication()
Retrieve sending application.

Returns:
Sending application HD.

getSendingFacility

public HD getSendingFacility()
Retrieve sending facility.

Returns:
Sending facility.

getReceivingApplication

public HD getReceivingApplication()
Retrieve receiving application.

Returns:
Receiving application HD.

getReceivingFacility

public HD getReceivingFacility()
Retrieve receiving facility.

Returns:
Receiving facility.

getMessageDateTime

public java.util.Date getMessageDateTime()
Retrieve message date/time.

Returns:
Message date/time.

getMessageType

public java.lang.String getMessageType()
Retrieve message type.

Returns:
Message type string.

getMessageControlId

public java.lang.String getMessageControlId()
Retrieve message control ID.

Returns:
Message control ID string.

getProcessingId

public ProcessingId getProcessingId()
Retrieve processing ID.

Returns:
Processing ID enumerator.

getVersionId

public java.lang.String getVersionId()
Retrieve version ID.

Returns:
Version ID string.

getAcceptAcknowledgementType

public AcknowledgementType getAcceptAcknowledgementType()
Retrieve accept acknowledgement type.

Returns:
AcknowledgementType.

getApplicationAcknowledgementType

public AcknowledgementType getApplicationAcknowledgementType()
Retrieve application acknowledgement type.

Returns:
AcknowledgementType.

getCountryCode

public CountryCode getCountryCode()
Retrieve country code.

Returns:
Country code.

parse

public static MSH parse(java.lang.String parseValue)
Parse MSH segment from string.

Parameters:
parseValue - String to be parsed (not null).
Returns:
MSH segment.

toString

public java.lang.String toString()
Outputs a formatted MSH segment.

Overrides:
toString in class java.lang.Object
Returns:
Formatted string.