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

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

All Implemented Interfaces:

Segment, Structure, Serializable

public class MFE
extends AbstractSegment

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

• MFE-1: Record-Level Event Code (ID)
• MFE-2: MFN Control ID (ST) optional
• MFE-3: Effective Date/Time (TS) optional
• MFE-4: Primary Key Value - MFE (Varies) repeating
• MFE-5: Primary Key Value Type (ID) repeating

See Also:

Serialized Form

Constructor Summary

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

Method Summary

protected Type	createNewTypeWithoutReflection(int field)
TS	getEffectiveDateTime() Returns MFE-3: "Effective Date/Time" - creates it if necessary
ID	getMfe1_RecordLevelEventCode() Returns MFE-1: "Record-Level Event Code" - creates it if necessary
ST	getMfe2_MFNControlID() Returns MFE-2: "MFN Control ID" - creates it if necessary
TS	getMfe3_EffectiveDateTime() Returns MFE-3: "Effective Date/Time" - creates it if necessary
Varies	getMfe4_PrimaryKeyValueMFE(int rep) Returns a specific repetition of MFE-4: "Primary Key Value - MFE" - creates it if necessary
int	getMfe4_PrimaryKeyValueMFEReps() Returns a count of the current number of repetitions of Primary Key Value - MFE (MFE-4).
ID	getMfe5_PrimaryKeyValueType(int rep) Returns a specific repetition of MFE-5: "Primary Key Value Type" - creates it if necessary
int	getMfe5_PrimaryKeyValueTypeReps() Returns a count of the current number of repetitions of Primary Key Value Type (MFE-5).
ST	getMFNControlID() Returns MFE-2: "MFN Control ID" - creates it if necessary
Varies[]	getPrimaryKeyValueMFE() Returns all repetitions of Primary Key Value - MFE (MFE-4).
Varies	getPrimaryKeyValueMFE(int rep) Returns a specific repetition of MFE-4: "Primary Key Value - MFE" - creates it if necessary
int	getPrimaryKeyValueMFEReps() Returns a count of the current number of repetitions of Primary Key Value - MFE (MFE-4).
ID[]	getPrimaryKeyValueType() Returns all repetitions of Primary Key Value Type (MFE-5).
ID	getPrimaryKeyValueType(int rep) Returns a specific repetition of MFE-5: "Primary Key Value Type" - creates it if necessary
int	getPrimaryKeyValueTypeReps() Returns a count of the current number of repetitions of Primary Key Value Type (MFE-5).
ID	getRecordLevelEventCode() Returns MFE-1: "Record-Level Event Code" - creates it if necessary
Varies	insertMfe4_PrimaryKeyValueMFE(int rep) Inserts a repetition of MFE-4: "Primary Key Value - MFE" at a specific index
ID	insertMfe5_PrimaryKeyValueType(int rep) Inserts a repetition of MFE-5: "Primary Key Value Type" at a specific index
Varies	insertPrimaryKeyValueMFE(int rep) Inserts a repetition of MFE-4: "Primary Key Value - MFE" at a specific index
ID	insertPrimaryKeyValueType(int rep) Inserts a repetition of MFE-5: "Primary Key Value Type" at a specific index
Varies	removeMfe4_PrimaryKeyValueMFE(int rep) Removes a repetition of MFE-4: "Primary Key Value - MFE" at a specific index
ID	removeMfe5_PrimaryKeyValueType(int rep) Removes a repetition of MFE-5: "Primary Key Value Type" at a specific index
Varies	removePrimaryKeyValueMFE(int rep) Removes a repetition of MFE-4: "Primary Key Value - MFE" at a specific index
ID	removePrimaryKeyValueType(int rep) Removes a repetition of MFE-5: "Primary Key Value Type" 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

MFE

public MFE(Group parent,
           ModelClassFactory factory)

Creates a new MFE segment

Method Detail

getRecordLevelEventCode

public ID getRecordLevelEventCode()

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

getMfe1_RecordLevelEventCode

public ID getMfe1_RecordLevelEventCode()

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

getMFNControlID

public ST getMFNControlID()

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

getMfe2_MFNControlID

public ST getMfe2_MFNControlID()

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

getEffectiveDateTime

public TS getEffectiveDateTime()

Returns MFE-3: "Effective Date/Time" - creates it if necessary

getMfe3_EffectiveDateTime

public TS getMfe3_EffectiveDateTime()

Returns MFE-3: "Effective Date/Time" - creates it if necessary

getPrimaryKeyValueMFE

public Varies[] getPrimaryKeyValueMFE()

Returns all repetitions of Primary Key Value - MFE (MFE-4).

getPrimaryKeyValueMFEReps

public int getPrimaryKeyValueMFEReps()

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

getPrimaryKeyValueMFE

public Varies getPrimaryKeyValueMFE(int rep)

Returns a specific repetition of MFE-4: "Primary Key Value - MFE" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getMfe4_PrimaryKeyValueMFE

public Varies getMfe4_PrimaryKeyValueMFE(int rep)

Returns a specific repetition of MFE-4: "Primary Key Value - MFE" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getMfe4_PrimaryKeyValueMFEReps

public int getMfe4_PrimaryKeyValueMFEReps()

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

insertPrimaryKeyValueMFE

public Varies insertPrimaryKeyValueMFE(int rep)
                                throws HL7Exception

Inserts a repetition of MFE-4: "Primary Key Value - MFE" 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)

insertMfe4_PrimaryKeyValueMFE

public Varies insertMfe4_PrimaryKeyValueMFE(int rep)
                                     throws HL7Exception

Inserts a repetition of MFE-4: "Primary Key Value - MFE" 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)

removePrimaryKeyValueMFE

public Varies removePrimaryKeyValueMFE(int rep)
                                throws HL7Exception

Removes a repetition of MFE-4: "Primary Key Value - MFE" 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)

removeMfe4_PrimaryKeyValueMFE

public Varies removeMfe4_PrimaryKeyValueMFE(int rep)
                                     throws HL7Exception

Removes a repetition of MFE-4: "Primary Key Value - MFE" 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)

getPrimaryKeyValueType

public ID[] getPrimaryKeyValueType()

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

getPrimaryKeyValueTypeReps

public int getPrimaryKeyValueTypeReps()

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

getPrimaryKeyValueType

public ID getPrimaryKeyValueType(int rep)

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

Parameters:

rep - The repetition index (0-indexed)

getMfe5_PrimaryKeyValueType

public ID getMfe5_PrimaryKeyValueType(int rep)

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

Parameters:

rep - The repetition index (0-indexed)

getMfe5_PrimaryKeyValueTypeReps

public int getMfe5_PrimaryKeyValueTypeReps()

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

insertPrimaryKeyValueType

public ID insertPrimaryKeyValueType(int rep)
                             throws HL7Exception

Inserts a repetition of MFE-5: "Primary Key Value Type" 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)

insertMfe5_PrimaryKeyValueType

public ID insertMfe5_PrimaryKeyValueType(int rep)
                                  throws HL7Exception

Inserts a repetition of MFE-5: "Primary Key Value Type" 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)

removePrimaryKeyValueType

public ID removePrimaryKeyValueType(int rep)
                             throws HL7Exception

Removes a repetition of MFE-5: "Primary Key Value Type" 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)

removeMfe5_PrimaryKeyValueType

public ID removeMfe5_PrimaryKeyValueType(int rep)
                                  throws HL7Exception

Removes a repetition of MFE-5: "Primary Key Value Type" 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