ca.uhn.hl7v2.model.v25.group

Class SUR_P09_FACILITY

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v25.group.SUR_P09_FACILITY

All Implemented Interfaces:

Group, Structure, Visitable, Serializable

public class SUR_P09_FACILITY
extends AbstractGroup

Represents a SUR_P09_FACILITY 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: FAC (Facility)
• 2: SUR_P09_PRODUCT (a Group object) repeating
• 3: PSH (Product Summary Header)
• 4: SUR_P09_FACILITY_DETAIL (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
SUR_P09_FACILITY(Group parent, ModelClassFactory factory) Creates a new SUR_P09_FACILITY group

Method Summary

Modifier and Type	Method and Description
FAC	getFAC() Returns FAC (Facility) - creates it if necessary
SUR_P09_FACILITY_DETAIL	getFACILITY_DETAIL() Returns the first repetition of FACILITY_DETAIL (a Group object) - creates it if necessary
SUR_P09_FACILITY_DETAIL	getFACILITY_DETAIL(int rep) Returns a specific repetition of FACILITY_DETAIL (a Group object) - creates it if necessary
List<SUR_P09_FACILITY_DETAIL>	getFACILITY_DETAILAll() Returns a non-modifiable List containing all current existing repetitions of FACILITY_DETAIL.
int	getFACILITY_DETAILReps() Returns the number of existing repetitions of FACILITY_DETAIL
SUR_P09_PRODUCT	getPRODUCT() Returns the first repetition of PRODUCT (a Group object) - creates it if necessary
SUR_P09_PRODUCT	getPRODUCT(int rep) Returns a specific repetition of PRODUCT (a Group object) - creates it if necessary
List<SUR_P09_PRODUCT>	getPRODUCTAll() Returns a non-modifiable List containing all current existing repetitions of PRODUCT.
int	getPRODUCTReps() Returns the number of existing repetitions of PRODUCT
PSH	getPSH() Returns PSH (Product Summary Header) - creates it if necessary
String	getVersion() Returns "2.5"
SUR_P09_FACILITY_DETAIL	insertFACILITY_DETAIL(int rep) Inserts a specific repetition of FACILITY_DETAIL (a Group object)
void	insertFACILITY_DETAIL(SUR_P09_FACILITY_DETAIL structure, int rep) Inserts a specific repetition of FACILITY_DETAIL (a Group object)
SUR_P09_PRODUCT	insertPRODUCT(int rep) Inserts a specific repetition of PRODUCT (a Group object)
void	insertPRODUCT(SUR_P09_PRODUCT structure, int rep) Inserts a specific repetition of PRODUCT (a Group object)
SUR_P09_FACILITY_DETAIL	removeFACILITY_DETAIL(int rep) Removes a specific repetition of FACILITY_DETAIL (a Group object)
SUR_P09_PRODUCT	removePRODUCT(int rep) Removes a specific repetition of PRODUCT (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

SUR_P09_FACILITY

public SUR_P09_FACILITY(Group parent,
                        ModelClassFactory factory)

Creates a new SUR_P09_FACILITY group

Method Detail

getVersion

public String getVersion()

Returns "2.5"

getFAC

public FAC getFAC()

Returns FAC (Facility) - creates it if necessary

getPRODUCT

public SUR_P09_PRODUCT getPRODUCT()

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

getPRODUCT

public SUR_P09_PRODUCT getPRODUCT(int rep)

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

getPRODUCTReps

public int getPRODUCTReps()

Returns the number of existing repetitions of PRODUCT

getPRODUCTAll

public List<SUR_P09_PRODUCT> getPRODUCTAll()
                                    throws HL7Exception

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

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

Throws:

HL7Exception

insertPRODUCT

public void insertPRODUCT(SUR_P09_PRODUCT structure,
                          int rep)
                   throws HL7Exception

Inserts a specific repetition of PRODUCT (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertPRODUCT

public SUR_P09_PRODUCT insertPRODUCT(int rep)
                              throws HL7Exception

Inserts a specific repetition of PRODUCT (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removePRODUCT

public SUR_P09_PRODUCT removePRODUCT(int rep)
                              throws HL7Exception

Removes a specific repetition of PRODUCT (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getPSH

public PSH getPSH()

Returns PSH (Product Summary Header) - creates it if necessary

getFACILITY_DETAIL

public SUR_P09_FACILITY_DETAIL getFACILITY_DETAIL()

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

getFACILITY_DETAIL

public SUR_P09_FACILITY_DETAIL getFACILITY_DETAIL(int rep)

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

getFACILITY_DETAILReps

public int getFACILITY_DETAILReps()

Returns the number of existing repetitions of FACILITY_DETAIL

getFACILITY_DETAILAll

public List<SUR_P09_FACILITY_DETAIL> getFACILITY_DETAILAll()
                                                    throws HL7Exception

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

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

Throws:

HL7Exception

insertFACILITY_DETAIL

public void insertFACILITY_DETAIL(SUR_P09_FACILITY_DETAIL structure,
                                  int rep)
                           throws HL7Exception

Inserts a specific repetition of FACILITY_DETAIL (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertFACILITY_DETAIL

public SUR_P09_FACILITY_DETAIL insertFACILITY_DETAIL(int rep)
                                              throws HL7Exception

Inserts a specific repetition of FACILITY_DETAIL (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeFACILITY_DETAIL

public SUR_P09_FACILITY_DETAIL removeFACILITY_DETAIL(int rep)
                                              throws HL7Exception

Removes a specific repetition of FACILITY_DETAIL (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)