ca.uhn.hl7v2.model.v26.message

Class OPL_O37

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.AbstractMessage

ca.uhn.hl7v2.model.v26.message.OPL_O37

All Implemented Interfaces:

Group, Message, Structure, Serializable

public class OPL_O37
extends AbstractMessage

Represents a OPL_O37 message structure (see chapter 4.4.14). This structure contains the following elements:

• 1: MSH (Message Header)
• 2: SFT (Software Segment) optional repeating
• 3: UAC (User Authentication Credential Segment) optional
• 4: NTE (Notes and Comments) optional repeating
• 5: ROL (Role) repeating
• 6: OPL_O37_GUARANTOR (a Group object) optional
• 7: OPL_O37_ORDER (a Group object) repeating

See Also:

Serialized Form

Field Summary

Fields inherited from class ca.uhn.hl7v2.model.AbstractStructure

log

Constructor Summary

Constructors

Constructor and Description
OPL_O37() Creates a new OPL_O37 message with DefaultModelClassFactory.
OPL_O37(ModelClassFactory factory) Creates a new OPL_O37 message with custom ModelClassFactory.

Method Summary

Methods

Modifier and Type	Method and Description
OPL_O37_GUARANTOR	getGUARANTOR() Returns GUARANTOR (a Group object) - creates it if necessary
MSH	getMSH() Returns MSH (Message Header) - creates it if necessary
NTE	getNTE() Returns the first repetition of NTE (Notes and Comments) - creates it if necessary
NTE	getNTE(int rep) Returns a specific repetition of NTE (Notes and Comments) - creates it if necessary
List<NTE>	getNTEAll() Returns a non-modifiable List containing all current existing repetitions of NTE.
int	getNTEReps() Returns the number of existing repetitions of NTE
OPL_O37_ORDER	getORDER() Returns the first repetition of ORDER (a Group object) - creates it if necessary
OPL_O37_ORDER	getORDER(int rep) Returns a specific repetition of ORDER (a Group object) - creates it if necessary
List<OPL_O37_ORDER>	getORDERAll() Returns a non-modifiable List containing all current existing repetitions of ORDER.
int	getORDERReps() Returns the number of existing repetitions of ORDER
ROL	getROL() Returns the first repetition of ROL (Role) - creates it if necessary
ROL	getROL(int rep) Returns a specific repetition of ROL (Role) - creates it if necessary
List<ROL>	getROLAll() Returns a non-modifiable List containing all current existing repetitions of ROL.
int	getROLReps() Returns the number of existing repetitions of ROL
SFT	getSFT() Returns the first repetition of SFT (Software Segment) - creates it if necessary
SFT	getSFT(int rep) Returns a specific repetition of SFT (Software Segment) - creates it if necessary
List<SFT>	getSFTAll() Returns a non-modifiable List containing all current existing repetitions of SFT.
int	getSFTReps() Returns the number of existing repetitions of SFT
UAC	getUAC() Returns UAC (User Authentication Credential Segment) - creates it if necessary
String	getVersion() Returns "2.6"
NTE	insertNTE(int rep) Inserts a specific repetition of NTE (Notes and Comments)
void	insertNTE(NTE structure, int rep) Inserts a specific repetition of NTE (Notes and Comments)
OPL_O37_ORDER	insertORDER(int rep) Inserts a specific repetition of ORDER (a Group object)
void	insertORDER(OPL_O37_ORDER structure, int rep) Inserts a specific repetition of ORDER (a Group object)
ROL	insertROL(int rep) Inserts a specific repetition of ROL (Role)
void	insertROL(ROL structure, int rep) Inserts a specific repetition of ROL (Role)
SFT	insertSFT(int rep) Inserts a specific repetition of SFT (Software Segment)
void	insertSFT(SFT structure, int rep) Inserts a specific repetition of SFT (Software Segment)
NTE	removeNTE(int rep) Removes a specific repetition of NTE (Notes and Comments)
OPL_O37_ORDER	removeORDER(int rep) Removes a specific repetition of ORDER (a Group object)
ROL	removeROL(int rep) Removes a specific repetition of ROL (Role)
SFT	removeSFT(int rep) Removes a specific repetition of SFT (Software Segment)

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

encode, generateACK, generateACK, getEncodingCharactersValue, getFieldSeparatorValue, getMessage, getParent, getParser, getValidationContext, initQuickstart, parse, printStructure, setParser, setValidationContext, toString

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

add, add, addNonstandardSegment, addNonstandardSegment, clear, currentReps, get, get, getAll, getAllAsList, getClass, getFieldNumForName, getModelClassFactory, getName, getNames, getNonStandardNames, getReps, getTyped, getTyped, insert, insertRepetition, insertRepetition, isGroup, isRepeating, isRequired, removeRepetition, tryToInstantiateStructure

Methods inherited from class java.lang.Object

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

Methods inherited from interface ca.uhn.hl7v2.model.Group

addNonstandardSegment, addNonstandardSegment, get, get, getAll, getClass, getNames, isGroup, isRepeating, isRequired

Methods inherited from interface ca.uhn.hl7v2.model.Structure

getName

Constructor Detail

OPL_O37

public OPL_O37()

Creates a new OPL_O37 message with DefaultModelClassFactory.

OPL_O37

public OPL_O37(ModelClassFactory factory)

Creates a new OPL_O37 message with custom ModelClassFactory.

Method Detail

getVersion

public String getVersion()

Returns "2.6"

Specified by:

getVersion in interface Message

Overrides:

getVersion in class AbstractMessage

getMSH

public MSH getMSH()

Returns MSH (Message Header) - creates it if necessary

getSFT

public SFT getSFT()

Returns the first repetition of SFT (Software Segment) - creates it if necessary

getSFT

public SFT getSFT(int rep)

Returns a specific repetition of SFT (Software Segment) - creates it if necessary

Parameters:

rep - The repetition index (0-indexed, i.e. the first repetition is at index 0)

Throws:

HL7Exception - if the repetition requested is more than one greater than the number of existing repetitions.

getSFTReps

public int getSFTReps()

Returns the number of existing repetitions of SFT

getSFTAll

public List<SFT> getSFTAll()
                    throws HL7Exception

Returns a non-modifiable List containing all current existing repetitions of SFT.

Note that unlike getSFT(), this method will not create any reps if none are already present, so an empty list may be returned.

Throws:

HL7Exception

insertSFT

public void insertSFT(SFT structure,
             int rep)
               throws HL7Exception

Inserts a specific repetition of SFT (Software Segment)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertSFT

public SFT insertSFT(int rep)
              throws HL7Exception

Inserts a specific repetition of SFT (Software Segment)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeSFT

public SFT removeSFT(int rep)
              throws HL7Exception

Removes a specific repetition of SFT (Software Segment)

Throws:

HL7Exception

See Also:

AbstractGroup#removeRepetition(String, int)

getUAC

public UAC getUAC()

Returns UAC (User Authentication Credential Segment) - creates it if necessary

getNTE

public NTE getNTE()

Returns the first repetition of NTE (Notes and Comments) - creates it if necessary

getNTE

public NTE getNTE(int rep)

Returns a specific repetition of NTE (Notes and Comments) - creates it if necessary

Parameters:

rep - The repetition index (0-indexed, i.e. the first repetition is at index 0)

Throws:

HL7Exception - if the repetition requested is more than one greater than the number of existing repetitions.

getNTEReps

public int getNTEReps()

Returns the number of existing repetitions of NTE

getNTEAll

public List<NTE> getNTEAll()
                    throws HL7Exception

Returns a non-modifiable List containing all current existing repetitions of NTE.

Note that unlike getNTE(), this method will not create any reps if none are already present, so an empty list may be returned.

Throws:

HL7Exception

insertNTE

public void insertNTE(NTE structure,
             int rep)
               throws HL7Exception

Inserts a specific repetition of NTE (Notes and Comments)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertNTE

public NTE insertNTE(int rep)
              throws HL7Exception

Inserts a specific repetition of NTE (Notes and Comments)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeNTE

public NTE removeNTE(int rep)
              throws HL7Exception

Removes a specific repetition of NTE (Notes and Comments)

Throws:

HL7Exception

See Also:

AbstractGroup#removeRepetition(String, int)

getROL

public ROL getROL()

Returns the first repetition of ROL (Role) - creates it if necessary

getROL

public ROL getROL(int rep)

Returns a specific repetition of ROL (Role) - creates it if necessary

Parameters:

rep - The repetition index (0-indexed, i.e. the first repetition is at index 0)

Throws:

HL7Exception - if the repetition requested is more than one greater than the number of existing repetitions.

getROLReps

public int getROLReps()

Returns the number of existing repetitions of ROL

getROLAll

public List<ROL> getROLAll()
                    throws HL7Exception

Returns a non-modifiable List containing all current existing repetitions of ROL.

Note that unlike getROL(), this method will not create any reps if none are already present, so an empty list may be returned.

Throws:

HL7Exception

insertROL

public void insertROL(ROL structure,
             int rep)
               throws HL7Exception

Inserts a specific repetition of ROL (Role)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertROL

public ROL insertROL(int rep)
              throws HL7Exception

Inserts a specific repetition of ROL (Role)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeROL

public ROL removeROL(int rep)
              throws HL7Exception

Removes a specific repetition of ROL (Role)

Throws:

HL7Exception

See Also:

AbstractGroup#removeRepetition(String, int)

getGUARANTOR

public OPL_O37_GUARANTOR getGUARANTOR()

Returns GUARANTOR (a Group object) - creates it if necessary

getORDER

public OPL_O37_ORDER getORDER()

Returns the first repetition of ORDER (a Group object) - creates it if necessary

getORDER

public OPL_O37_ORDER getORDER(int rep)

Returns a specific repetition of ORDER (a Group object) - creates it if necessary

Parameters:

rep - The repetition index (0-indexed, i.e. the first repetition is at index 0)

Throws:

HL7Exception - if the repetition requested is more than one greater than the number of existing repetitions.

getORDERReps

public int getORDERReps()

Returns the number of existing repetitions of ORDER

getORDERAll

public List<OPL_O37_ORDER> getORDERAll()
                                throws HL7Exception

Returns a non-modifiable List containing all current existing repetitions of ORDER.

Note that unlike getORDER(), this method will not create any reps if none are already present, so an empty list may be returned.

Throws:

HL7Exception

insertORDER

public void insertORDER(OPL_O37_ORDER structure,
               int rep)
                 throws HL7Exception

Inserts a specific repetition of ORDER (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertORDER

public OPL_O37_ORDER insertORDER(int rep)
                          throws HL7Exception

Inserts a specific repetition of ORDER (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeORDER

public OPL_O37_ORDER removeORDER(int rep)
                          throws HL7Exception

Removes a specific repetition of ORDER (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#removeRepetition(String, int)