ca.uhn.hl7v2.model.v24.segment
Class MFA

java.lang.Object
  ca.uhn.hl7v2.model.AbstractSegment
      ca.uhn.hl7v2.model.v24.segment.MFA

All Implemented Interfaces:

Segment, Structure, Serializable

public class MFA
extends AbstractSegment

Represents an HL7 MFA message segment (Master File Acknowledgment). This segment has the following fields:

• MFA-1: Record-Level Event Code (ID)
• MFA-2: MFN Control ID (ST) optional
• MFA-3: Event Completion Date/Time (TS) optional
• MFA-4: MFN Record Level Error Return (CE)
• MFA-5: Primary Key Value - MFA (CE) repeating
• MFA-6: Primary Key Value Type - MFA (ID) repeating

See Also:

Serialized Form

Constructor Summary

MFA(Group parent, ModelClassFactory factory)
Creates a new MFA segment

Method Summary

protected Type	createNewTypeWithoutReflection(int field)
TS	getEventCompletionDateTime() Returns MFA-3: "Event Completion Date/Time" - creates it if necessary
ID	getMfa1_RecordLevelEventCode() Returns MFA-1: "Record-Level Event Code" - creates it if necessary
ST	getMfa2_MFNControlID() Returns MFA-2: "MFN Control ID" - creates it if necessary
TS	getMfa3_EventCompletionDateTime() Returns MFA-3: "Event Completion Date/Time" - creates it if necessary
CE	getMfa4_MFNRecordLevelErrorReturn() Returns MFA-4: "MFN Record Level Error Return" - creates it if necessary
CE	getMfa5_PrimaryKeyValueMFA(int rep) Returns a specific repetition of MFA-5: "Primary Key Value - MFA" - creates it if necessary
int	getMfa5_PrimaryKeyValueMFAReps() Returns a count of the current number of repetitions of Primary Key Value - MFA (MFA-5).
ID	getMfa6_PrimaryKeyValueTypeMFA(int rep) Returns a specific repetition of MFA-6: "Primary Key Value Type - MFA" - creates it if necessary
int	getMfa6_PrimaryKeyValueTypeMFAReps() Returns a count of the current number of repetitions of Primary Key Value Type - MFA (MFA-6).
ST	getMFNControlID() Returns MFA-2: "MFN Control ID" - creates it if necessary
CE	getMFNRecordLevelErrorReturn() Returns MFA-4: "MFN Record Level Error Return" - creates it if necessary
CE[]	getPrimaryKeyValueMFA() Returns all repetitions of Primary Key Value - MFA (MFA-5).
CE	getPrimaryKeyValueMFA(int rep) Returns a specific repetition of MFA-5: "Primary Key Value - MFA" - creates it if necessary
int	getPrimaryKeyValueMFAReps() Returns a count of the current number of repetitions of Primary Key Value - MFA (MFA-5).
ID[]	getPrimaryKeyValueTypeMFA() Returns all repetitions of Primary Key Value Type - MFA (MFA-6).
ID	getPrimaryKeyValueTypeMFA(int rep) Returns a specific repetition of MFA-6: "Primary Key Value Type - MFA" - creates it if necessary
int	getPrimaryKeyValueTypeMFAReps() Returns a count of the current number of repetitions of Primary Key Value Type - MFA (MFA-6).
ID	getRecordLevelEventCode() Returns MFA-1: "Record-Level Event Code" - creates it if necessary
CE	insertMfa5_PrimaryKeyValueMFA(int rep) Inserts a repetition of MFA-5: "Primary Key Value - MFA" at a specific index
ID	insertMfa6_PrimaryKeyValueTypeMFA(int rep) Inserts a repetition of MFA-6: "Primary Key Value Type - MFA" at a specific index
CE	insertPrimaryKeyValueMFA(int rep) Inserts a repetition of MFA-5: "Primary Key Value - MFA" at a specific index
ID	insertPrimaryKeyValueTypeMFA(int rep) Inserts a repetition of MFA-6: "Primary Key Value Type - MFA" at a specific index
CE	removeMfa5_PrimaryKeyValueMFA(int rep) Removes a repetition of MFA-5: "Primary Key Value - MFA" at a specific index
ID	removeMfa6_PrimaryKeyValueTypeMFA(int rep) Removes a repetition of MFA-6: "Primary Key Value Type - MFA" at a specific index
CE	removePrimaryKeyValueMFA(int rep) Removes a repetition of MFA-5: "Primary Key Value - MFA" at a specific index
ID	removePrimaryKeyValueTypeMFA(int rep) Removes a repetition of MFA-6: "Primary Key Value Type - MFA" at a specific index

Methods inherited from class ca.uhn.hl7v2.model.AbstractSegment

add, add, clear, encode, getField, getField, getLength, getMaxCardinality, getMessage, getName, getNames, getParent, insertRepetition, isRequired, main, numFields, parse, removeRepetition

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MFA

public MFA(Group parent,
           ModelClassFactory factory)

Creates a new MFA segment

Method Detail

getRecordLevelEventCode

public ID getRecordLevelEventCode()

Returns MFA-1: "Record-Level Event Code" - creates it if necessary

getMfa1_RecordLevelEventCode

public ID getMfa1_RecordLevelEventCode()

Returns MFA-1: "Record-Level Event Code" - creates it if necessary

getMFNControlID

public ST getMFNControlID()

Returns MFA-2: "MFN Control ID" - creates it if necessary

getMfa2_MFNControlID

public ST getMfa2_MFNControlID()

Returns MFA-2: "MFN Control ID" - creates it if necessary

getEventCompletionDateTime

public TS getEventCompletionDateTime()

Returns MFA-3: "Event Completion Date/Time" - creates it if necessary

getMfa3_EventCompletionDateTime

public TS getMfa3_EventCompletionDateTime()

Returns MFA-3: "Event Completion Date/Time" - creates it if necessary

getMFNRecordLevelErrorReturn

public CE getMFNRecordLevelErrorReturn()

Returns MFA-4: "MFN Record Level Error Return" - creates it if necessary

getMfa4_MFNRecordLevelErrorReturn

public CE getMfa4_MFNRecordLevelErrorReturn()

Returns MFA-4: "MFN Record Level Error Return" - creates it if necessary

getPrimaryKeyValueMFA

public CE[] getPrimaryKeyValueMFA()

Returns all repetitions of Primary Key Value - MFA (MFA-5).

getPrimaryKeyValueMFAReps

public int getPrimaryKeyValueMFAReps()

Returns a count of the current number of repetitions of Primary Key Value - MFA (MFA-5). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

getPrimaryKeyValueMFA

public CE getPrimaryKeyValueMFA(int rep)

Returns a specific repetition of MFA-5: "Primary Key Value - MFA" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getMfa5_PrimaryKeyValueMFA

public CE getMfa5_PrimaryKeyValueMFA(int rep)

Returns a specific repetition of MFA-5: "Primary Key Value - MFA" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getMfa5_PrimaryKeyValueMFAReps

public int getMfa5_PrimaryKeyValueMFAReps()

Returns a count of the current number of repetitions of Primary Key Value - MFA (MFA-5). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

insertPrimaryKeyValueMFA

public CE insertPrimaryKeyValueMFA(int rep)
                            throws HL7Exception

Inserts a repetition of MFA-5: "Primary Key Value - MFA" at a specific index

Parameters:

rep - The repetition index (0-indexed)

Throws:

HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

insertMfa5_PrimaryKeyValueMFA

public CE insertMfa5_PrimaryKeyValueMFA(int rep)
                                 throws HL7Exception

Inserts a repetition of MFA-5: "Primary Key Value - MFA" at a specific index

Parameters:

rep - The repetition index (0-indexed)

Throws:

HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

removePrimaryKeyValueMFA

public CE removePrimaryKeyValueMFA(int rep)
                            throws HL7Exception

Removes a repetition of MFA-5: "Primary Key Value - MFA" at a specific index

Parameters:

rep - The repetition index (0-indexed)

Throws:

HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

removeMfa5_PrimaryKeyValueMFA

public CE removeMfa5_PrimaryKeyValueMFA(int rep)
                                 throws HL7Exception

Removes a repetition of MFA-5: "Primary Key Value - MFA" at a specific index

Parameters:

rep - The repetition index (0-indexed)

Throws:

HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

getPrimaryKeyValueTypeMFA

public ID[] getPrimaryKeyValueTypeMFA()

Returns all repetitions of Primary Key Value Type - MFA (MFA-6).

getPrimaryKeyValueTypeMFAReps

public int getPrimaryKeyValueTypeMFAReps()

Returns a count of the current number of repetitions of Primary Key Value Type - MFA (MFA-6). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

getPrimaryKeyValueTypeMFA

public ID getPrimaryKeyValueTypeMFA(int rep)

Returns a specific repetition of MFA-6: "Primary Key Value Type - MFA" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getMfa6_PrimaryKeyValueTypeMFA

public ID getMfa6_PrimaryKeyValueTypeMFA(int rep)

Returns a specific repetition of MFA-6: "Primary Key Value Type - MFA" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getMfa6_PrimaryKeyValueTypeMFAReps

public int getMfa6_PrimaryKeyValueTypeMFAReps()

Returns a count of the current number of repetitions of Primary Key Value Type - MFA (MFA-6). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

insertPrimaryKeyValueTypeMFA

public ID insertPrimaryKeyValueTypeMFA(int rep)
                                throws HL7Exception

Inserts a repetition of MFA-6: "Primary Key Value Type - MFA" at a specific index

Parameters:

rep - The repetition index (0-indexed)

Throws:

HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

insertMfa6_PrimaryKeyValueTypeMFA

public ID insertMfa6_PrimaryKeyValueTypeMFA(int rep)
                                     throws HL7Exception

Inserts a repetition of MFA-6: "Primary Key Value Type - MFA" at a specific index

Parameters:

rep - The repetition index (0-indexed)

Throws:

HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

removePrimaryKeyValueTypeMFA

public ID removePrimaryKeyValueTypeMFA(int rep)
                                throws HL7Exception

Removes a repetition of MFA-6: "Primary Key Value Type - MFA" at a specific index

Parameters:

rep - The repetition index (0-indexed)

Throws:

HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

removeMfa6_PrimaryKeyValueTypeMFA

public ID removeMfa6_PrimaryKeyValueTypeMFA(int rep)
                                     throws HL7Exception

Removes a repetition of MFA-6: "Primary Key Value Type - MFA" at a specific index

Parameters:

rep - The repetition index (0-indexed)

Throws:

HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

createNewTypeWithoutReflection

protected Type createNewTypeWithoutReflection(int field)

Overrides:

createNewTypeWithoutReflection in class AbstractSegment