ca.uhn.hl7v2.model.v231.group

Class SQM_S25_RGSAISAPRAIGAPRAIPAPRAILAPR

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v231.group.SQM_S25_RGSAISAPRAIGAPRAIPAPRAILAPR

All Implemented Interfaces:

Group, Structure, Visitable, Serializable

public class SQM_S25_RGSAISAPRAIGAPRAIPAPRAILAPR
extends AbstractGroup

Represents a SQM_S25_RGSAISAPRAIGAPRAIPAPRAILAPR 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: SQM_S25_AISAPR (a Group object) optional repeating
• 3: SQM_S25_AIGAPR (a Group object) optional repeating
• 4: SQM_S25_AIPAPR (a Group object) optional repeating
• 5: SQM_S25_AILAPR (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
SQM_S25_RGSAISAPRAIGAPRAIPAPRAILAPR(Group parent, ModelClassFactory factory) Creates a new SQM_S25_RGSAISAPRAIGAPRAIPAPRAILAPR group

Method Summary

Modifier and Type	Method and Description
SQM_S25_AIGAPR	getAIGAPR() Returns the first repetition of AIGAPR (a Group object) - creates it if necessary
SQM_S25_AIGAPR	getAIGAPR(int rep) Returns a specific repetition of AIGAPR (a Group object) - creates it if necessary
List<SQM_S25_AIGAPR>	getAIGAPRAll() Returns a non-modifiable List containing all current existing repetitions of AIGAPR.
int	getAIGAPRReps() Returns the number of existing repetitions of AIGAPR
SQM_S25_AILAPR	getAILAPR() Returns the first repetition of AILAPR (a Group object) - creates it if necessary
SQM_S25_AILAPR	getAILAPR(int rep) Returns a specific repetition of AILAPR (a Group object) - creates it if necessary
List<SQM_S25_AILAPR>	getAILAPRAll() Returns a non-modifiable List containing all current existing repetitions of AILAPR.
int	getAILAPRReps() Returns the number of existing repetitions of AILAPR
SQM_S25_AIPAPR	getAIPAPR() Returns the first repetition of AIPAPR (a Group object) - creates it if necessary
SQM_S25_AIPAPR	getAIPAPR(int rep) Returns a specific repetition of AIPAPR (a Group object) - creates it if necessary
List<SQM_S25_AIPAPR>	getAIPAPRAll() Returns a non-modifiable List containing all current existing repetitions of AIPAPR.
int	getAIPAPRReps() Returns the number of existing repetitions of AIPAPR
SQM_S25_AISAPR	getAISAPR() Returns the first repetition of AISAPR (a Group object) - creates it if necessary
SQM_S25_AISAPR	getAISAPR(int rep) Returns a specific repetition of AISAPR (a Group object) - creates it if necessary
List<SQM_S25_AISAPR>	getAISAPRAll() Returns a non-modifiable List containing all current existing repetitions of AISAPR.
int	getAISAPRReps() Returns the number of existing repetitions of AISAPR
RGS	getRGS() Returns RGS (RGS - resource group segment) - creates it if necessary
String	getVersion() Returns "2.3.1"
SQM_S25_AIGAPR	insertAIGAPR(int rep) Inserts a specific repetition of AIGAPR (a Group object)
void	insertAIGAPR(SQM_S25_AIGAPR structure, int rep) Inserts a specific repetition of AIGAPR (a Group object)
SQM_S25_AILAPR	insertAILAPR(int rep) Inserts a specific repetition of AILAPR (a Group object)
void	insertAILAPR(SQM_S25_AILAPR structure, int rep) Inserts a specific repetition of AILAPR (a Group object)
SQM_S25_AIPAPR	insertAIPAPR(int rep) Inserts a specific repetition of AIPAPR (a Group object)
void	insertAIPAPR(SQM_S25_AIPAPR structure, int rep) Inserts a specific repetition of AIPAPR (a Group object)
SQM_S25_AISAPR	insertAISAPR(int rep) Inserts a specific repetition of AISAPR (a Group object)
void	insertAISAPR(SQM_S25_AISAPR structure, int rep) Inserts a specific repetition of AISAPR (a Group object)
SQM_S25_AIGAPR	removeAIGAPR(int rep) Removes a specific repetition of AIGAPR (a Group object)
SQM_S25_AILAPR	removeAILAPR(int rep) Removes a specific repetition of AILAPR (a Group object)
SQM_S25_AIPAPR	removeAIPAPR(int rep) Removes a specific repetition of AIPAPR (a Group object)
SQM_S25_AISAPR	removeAISAPR(int rep) Removes a specific repetition of AISAPR (a Group object)

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

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

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

SQM_S25_RGSAISAPRAIGAPRAIPAPRAILAPR

public SQM_S25_RGSAISAPRAIGAPRAIPAPRAILAPR(Group parent,
                                           ModelClassFactory factory)

Creates a new SQM_S25_RGSAISAPRAIGAPRAIPAPRAILAPR 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

getAISAPR

public SQM_S25_AISAPR getAISAPR()

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

getAISAPR

public SQM_S25_AISAPR getAISAPR(int rep)

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

getAISAPRReps

public int getAISAPRReps()

Returns the number of existing repetitions of AISAPR

getAISAPRAll

public List<SQM_S25_AISAPR> getAISAPRAll()
                                  throws HL7Exception

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

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

Throws:

HL7Exception

insertAISAPR

public void insertAISAPR(SQM_S25_AISAPR structure,
                         int rep)
                  throws HL7Exception

Inserts a specific repetition of AISAPR (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertAISAPR

public SQM_S25_AISAPR insertAISAPR(int rep)
                            throws HL7Exception

Inserts a specific repetition of AISAPR (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeAISAPR

public SQM_S25_AISAPR removeAISAPR(int rep)
                            throws HL7Exception

Removes a specific repetition of AISAPR (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getAIGAPR

public SQM_S25_AIGAPR getAIGAPR()

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

getAIGAPR

public SQM_S25_AIGAPR getAIGAPR(int rep)

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

getAIGAPRReps

public int getAIGAPRReps()

Returns the number of existing repetitions of AIGAPR

getAIGAPRAll

public List<SQM_S25_AIGAPR> getAIGAPRAll()
                                  throws HL7Exception

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

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

Throws:

HL7Exception

insertAIGAPR

public void insertAIGAPR(SQM_S25_AIGAPR structure,
                         int rep)
                  throws HL7Exception

Inserts a specific repetition of AIGAPR (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertAIGAPR

public SQM_S25_AIGAPR insertAIGAPR(int rep)
                            throws HL7Exception

Inserts a specific repetition of AIGAPR (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeAIGAPR

public SQM_S25_AIGAPR removeAIGAPR(int rep)
                            throws HL7Exception

Removes a specific repetition of AIGAPR (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getAIPAPR

public SQM_S25_AIPAPR getAIPAPR()

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

getAIPAPR

public SQM_S25_AIPAPR getAIPAPR(int rep)

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

getAIPAPRReps

public int getAIPAPRReps()

Returns the number of existing repetitions of AIPAPR

getAIPAPRAll

public List<SQM_S25_AIPAPR> getAIPAPRAll()
                                  throws HL7Exception

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

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

Throws:

HL7Exception

insertAIPAPR

public void insertAIPAPR(SQM_S25_AIPAPR structure,
                         int rep)
                  throws HL7Exception

Inserts a specific repetition of AIPAPR (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertAIPAPR

public SQM_S25_AIPAPR insertAIPAPR(int rep)
                            throws HL7Exception

Inserts a specific repetition of AIPAPR (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeAIPAPR

public SQM_S25_AIPAPR removeAIPAPR(int rep)
                            throws HL7Exception

Removes a specific repetition of AIPAPR (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getAILAPR

public SQM_S25_AILAPR getAILAPR()

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

getAILAPR

public SQM_S25_AILAPR getAILAPR(int rep)

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

getAILAPRReps

public int getAILAPRReps()

Returns the number of existing repetitions of AILAPR

getAILAPRAll

public List<SQM_S25_AILAPR> getAILAPRAll()
                                  throws HL7Exception

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

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

Throws:

HL7Exception

insertAILAPR

public void insertAILAPR(SQM_S25_AILAPR structure,
                         int rep)
                  throws HL7Exception

Inserts a specific repetition of AILAPR (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertAILAPR

public SQM_S25_AILAPR insertAILAPR(int rep)
                            throws HL7Exception

Inserts a specific repetition of AILAPR (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeAILAPR

public SQM_S25_AILAPR removeAILAPR(int rep)
                            throws HL7Exception

Removes a specific repetition of AILAPR (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)