ca.uhn.hl7v2.model.v231.group

Class SQR_S25_RGSAISNTEAIGNTEAIPNTEAILNTE

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v231.group.SQR_S25_RGSAISNTEAIGNTEAIPNTEAILNTE

All Implemented Interfaces:

Group, Structure, Serializable

public class SQR_S25_RGSAISNTEAIGNTEAIPNTEAILNTE
extends AbstractGroup

Represents a SQR_S25_RGSAISNTEAIGNTEAIPNTEAILNTE group structure (a Group object). A Group is an ordered collection of message segments that can repeat together or be optionally in/excluded together. This Group contains the following elements:

• 1: RGS (RGS - resource group segment)
• 2: SQR_S25_AISNTE (a Group object) optional repeating
• 3: SQR_S25_AIGNTE (a Group object) optional repeating
• 4: SQR_S25_AIPNTE (a Group object) optional repeating
• 5: SQR_S25_AILNTE (a Group object) optional repeating

See Also:

Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

Constructor and Description
SQR_S25_RGSAISNTEAIGNTEAIPNTEAILNTE(Group parent, ModelClassFactory factory) Creates a new SQR_S25_RGSAISNTEAIGNTEAIPNTEAILNTE group

Method Summary

Methods

Modifier and Type	Method and Description
SQR_S25_AIGNTE	getAIGNTE() Returns the first repetition of AIGNTE (a Group object) - creates it if necessary
SQR_S25_AIGNTE	getAIGNTE(int rep) Returns a specific repetition of AIGNTE (a Group object) - creates it if necessary
List<SQR_S25_AIGNTE>	getAIGNTEAll() Returns a non-modifiable List containing all current existing repetitions of AIGNTE.
int	getAIGNTEReps() Returns the number of existing repetitions of AIGNTE
SQR_S25_AILNTE	getAILNTE() Returns the first repetition of AILNTE (a Group object) - creates it if necessary
SQR_S25_AILNTE	getAILNTE(int rep) Returns a specific repetition of AILNTE (a Group object) - creates it if necessary
List<SQR_S25_AILNTE>	getAILNTEAll() Returns a non-modifiable List containing all current existing repetitions of AILNTE.
int	getAILNTEReps() Returns the number of existing repetitions of AILNTE
SQR_S25_AIPNTE	getAIPNTE() Returns the first repetition of AIPNTE (a Group object) - creates it if necessary
SQR_S25_AIPNTE	getAIPNTE(int rep) Returns a specific repetition of AIPNTE (a Group object) - creates it if necessary
List<SQR_S25_AIPNTE>	getAIPNTEAll() Returns a non-modifiable List containing all current existing repetitions of AIPNTE.
int	getAIPNTEReps() Returns the number of existing repetitions of AIPNTE
SQR_S25_AISNTE	getAISNTE() Returns the first repetition of AISNTE (a Group object) - creates it if necessary
SQR_S25_AISNTE	getAISNTE(int rep) Returns a specific repetition of AISNTE (a Group object) - creates it if necessary
List<SQR_S25_AISNTE>	getAISNTEAll() Returns a non-modifiable List containing all current existing repetitions of AISNTE.
int	getAISNTEReps() Returns the number of existing repetitions of AISNTE
RGS	getRGS() Returns RGS (RGS - resource group segment) - creates it if necessary
String	getVersion() Returns "2.3.1"
SQR_S25_AIGNTE	insertAIGNTE(int rep) Inserts a specific repetition of AIGNTE (a Group object)
void	insertAIGNTE(SQR_S25_AIGNTE structure, int rep) Inserts a specific repetition of AIGNTE (a Group object)
SQR_S25_AILNTE	insertAILNTE(int rep) Inserts a specific repetition of AILNTE (a Group object)
void	insertAILNTE(SQR_S25_AILNTE structure, int rep) Inserts a specific repetition of AILNTE (a Group object)
SQR_S25_AIPNTE	insertAIPNTE(int rep) Inserts a specific repetition of AIPNTE (a Group object)
void	insertAIPNTE(SQR_S25_AIPNTE structure, int rep) Inserts a specific repetition of AIPNTE (a Group object)
SQR_S25_AISNTE	insertAISNTE(int rep) Inserts a specific repetition of AISNTE (a Group object)
void	insertAISNTE(SQR_S25_AISNTE structure, int rep) Inserts a specific repetition of AISNTE (a Group object)
SQR_S25_AIGNTE	removeAIGNTE(int rep) Removes a specific repetition of AIGNTE (a Group object)
SQR_S25_AILNTE	removeAILNTE(int rep) Removes a specific repetition of AILNTE (a Group object)
SQR_S25_AIPNTE	removeAIPNTE(int rep) Removes a specific repetition of AIPNTE (a Group object)
SQR_S25_AISNTE	removeAISNTE(int rep) Removes a specific repetition of AISNTE (a Group object)

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 ca.uhn.hl7v2.model.AbstractStructure

getMessage, getParent

Methods inherited from class java.lang.Object

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

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

getMessage, getParent

Constructor Detail

SQR_S25_RGSAISNTEAIGNTEAIPNTEAILNTE

public SQR_S25_RGSAISNTEAIGNTEAIPNTEAILNTE(Group parent,
                                   ModelClassFactory factory)

Creates a new SQR_S25_RGSAISNTEAIGNTEAIPNTEAILNTE group

Method Detail

getVersion

public String getVersion()

Returns "2.3.1"

getRGS

public RGS getRGS()

Returns RGS (RGS - resource group segment) - creates it if necessary

getAISNTE

public SQR_S25_AISNTE getAISNTE()

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

getAISNTE

public SQR_S25_AISNTE getAISNTE(int rep)

Returns a specific repetition of AISNTE (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.

getAISNTEReps

public int getAISNTEReps()

Returns the number of existing repetitions of AISNTE

getAISNTEAll

public List<SQR_S25_AISNTE> getAISNTEAll()
                                  throws HL7Exception

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

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

Throws:

HL7Exception

insertAISNTE

public void insertAISNTE(SQR_S25_AISNTE structure,
                int rep)
                  throws HL7Exception

Inserts a specific repetition of AISNTE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertAISNTE

public SQR_S25_AISNTE insertAISNTE(int rep)
                            throws HL7Exception

Inserts a specific repetition of AISNTE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeAISNTE

public SQR_S25_AISNTE removeAISNTE(int rep)
                            throws HL7Exception

Removes a specific repetition of AISNTE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getAIGNTE

public SQR_S25_AIGNTE getAIGNTE()

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

getAIGNTE

public SQR_S25_AIGNTE getAIGNTE(int rep)

Returns a specific repetition of AIGNTE (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.

getAIGNTEReps

public int getAIGNTEReps()

Returns the number of existing repetitions of AIGNTE

getAIGNTEAll

public List<SQR_S25_AIGNTE> getAIGNTEAll()
                                  throws HL7Exception

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

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

Throws:

HL7Exception

insertAIGNTE

public void insertAIGNTE(SQR_S25_AIGNTE structure,
                int rep)
                  throws HL7Exception

Inserts a specific repetition of AIGNTE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertAIGNTE

public SQR_S25_AIGNTE insertAIGNTE(int rep)
                            throws HL7Exception

Inserts a specific repetition of AIGNTE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeAIGNTE

public SQR_S25_AIGNTE removeAIGNTE(int rep)
                            throws HL7Exception

Removes a specific repetition of AIGNTE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getAIPNTE

public SQR_S25_AIPNTE getAIPNTE()

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

getAIPNTE

public SQR_S25_AIPNTE getAIPNTE(int rep)

Returns a specific repetition of AIPNTE (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.

getAIPNTEReps

public int getAIPNTEReps()

Returns the number of existing repetitions of AIPNTE

getAIPNTEAll

public List<SQR_S25_AIPNTE> getAIPNTEAll()
                                  throws HL7Exception

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

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

Throws:

HL7Exception

insertAIPNTE

public void insertAIPNTE(SQR_S25_AIPNTE structure,
                int rep)
                  throws HL7Exception

Inserts a specific repetition of AIPNTE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertAIPNTE

public SQR_S25_AIPNTE insertAIPNTE(int rep)
                            throws HL7Exception

Inserts a specific repetition of AIPNTE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeAIPNTE

public SQR_S25_AIPNTE removeAIPNTE(int rep)
                            throws HL7Exception

Removes a specific repetition of AIPNTE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getAILNTE

public SQR_S25_AILNTE getAILNTE()

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

getAILNTE

public SQR_S25_AILNTE getAILNTE(int rep)

Returns a specific repetition of AILNTE (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.

getAILNTEReps

public int getAILNTEReps()

Returns the number of existing repetitions of AILNTE

getAILNTEAll

public List<SQR_S25_AILNTE> getAILNTEAll()
                                  throws HL7Exception

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

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

Throws:

HL7Exception

insertAILNTE

public void insertAILNTE(SQR_S25_AILNTE structure,
                int rep)
                  throws HL7Exception

Inserts a specific repetition of AILNTE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertAILNTE

public SQR_S25_AILNTE insertAILNTE(int rep)
                            throws HL7Exception

Inserts a specific repetition of AILNTE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeAILNTE

public SQR_S25_AILNTE removeAILNTE(int rep)
                            throws HL7Exception

Removes a specific repetition of AILNTE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)