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

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

All Implemented Interfaces:

Segment, Structure, Serializable

public class SPR
extends AbstractSegment

Represents an HL7 SPR message segment (Stored Procedure Request Definition). This segment has the following fields:

• SPR-1: Query Tag (ST) optional
• SPR-2: Query/Response Format Code (ID)
• SPR-3: Stored Procedure Name (CE)
• SPR-4: Input Parameter List (QIP) optional repeating

See Also:

Serialized Form

Constructor Summary

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

Method Summary

protected Type	createNewTypeWithoutReflection(int field)
QIP[]	getInputParameterList() Returns all repetitions of Input Parameter List (SPR-4).
QIP	getInputParameterList(int rep) Returns a specific repetition of SPR-4: "Input Parameter List" - creates it if necessary
int	getInputParameterListReps() Returns a count of the current number of repetitions of Input Parameter List (SPR-4).
ID	getQueryResponseFormatCode() Returns SPR-2: "Query/Response Format Code" - creates it if necessary
ST	getQueryTag() Returns SPR-1: "Query Tag" - creates it if necessary
ST	getSpr1_QueryTag() Returns SPR-1: "Query Tag" - creates it if necessary
ID	getSpr2_QueryResponseFormatCode() Returns SPR-2: "Query/Response Format Code" - creates it if necessary
CE	getSpr3_StoredProcedureName() Returns SPR-3: "Stored Procedure Name" - creates it if necessary
QIP	getSpr4_InputParameterList(int rep) Returns a specific repetition of SPR-4: "Input Parameter List" - creates it if necessary
int	getSpr4_InputParameterListReps() Returns a count of the current number of repetitions of Input Parameter List (SPR-4).
CE	getStoredProcedureName() Returns SPR-3: "Stored Procedure Name" - creates it if necessary
QIP	insertInputParameterList(int rep) Inserts a repetition of SPR-4: "Input Parameter List" at a specific index
QIP	insertSpr4_InputParameterList(int rep) Inserts a repetition of SPR-4: "Input Parameter List" at a specific index
QIP	removeInputParameterList(int rep) Removes a repetition of SPR-4: "Input Parameter List" at a specific index
QIP	removeSpr4_InputParameterList(int rep) Removes a repetition of SPR-4: "Input Parameter List" 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

SPR

public SPR(Group parent,
           ModelClassFactory factory)

Creates a new SPR segment

Method Detail

getQueryTag

public ST getQueryTag()

Returns SPR-1: "Query Tag" - creates it if necessary

getSpr1_QueryTag

public ST getSpr1_QueryTag()

Returns SPR-1: "Query Tag" - creates it if necessary

getQueryResponseFormatCode

public ID getQueryResponseFormatCode()

Returns SPR-2: "Query/Response Format Code" - creates it if necessary

getSpr2_QueryResponseFormatCode

public ID getSpr2_QueryResponseFormatCode()

Returns SPR-2: "Query/Response Format Code" - creates it if necessary

getStoredProcedureName

public CE getStoredProcedureName()

Returns SPR-3: "Stored Procedure Name" - creates it if necessary

getSpr3_StoredProcedureName

public CE getSpr3_StoredProcedureName()

Returns SPR-3: "Stored Procedure Name" - creates it if necessary

getInputParameterList

public QIP[] getInputParameterList()

Returns all repetitions of Input Parameter List (SPR-4).

getInputParameterListReps

public int getInputParameterListReps()

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

getInputParameterList

public QIP getInputParameterList(int rep)

Returns a specific repetition of SPR-4: "Input Parameter List" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getSpr4_InputParameterList

public QIP getSpr4_InputParameterList(int rep)

Returns a specific repetition of SPR-4: "Input Parameter List" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getSpr4_InputParameterListReps

public int getSpr4_InputParameterListReps()

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

insertInputParameterList

public QIP insertInputParameterList(int rep)
                             throws HL7Exception

Inserts a repetition of SPR-4: "Input Parameter List" 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)

insertSpr4_InputParameterList

public QIP insertSpr4_InputParameterList(int rep)
                                  throws HL7Exception

Inserts a repetition of SPR-4: "Input Parameter List" 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)

removeInputParameterList

public QIP removeInputParameterList(int rep)
                             throws HL7Exception

Removes a repetition of SPR-4: "Input Parameter List" 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)

removeSpr4_InputParameterList

public QIP removeSpr4_InputParameterList(int rep)
                                  throws HL7Exception

Removes a repetition of SPR-4: "Input Parameter List" 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