org.hl7.rim

Interface Batch

public interface Batch extends RimObject, Transmission

Interface for RIM class Batch.

The Batch class is used to specify a message which is a collection of HL7 V3 messages.

Method Summary
void	addTransmission(Transmission value) Adds an association 'transmission' to RIM class Transmission.
SET<ST>	getBatchComment() Gets attribute batchComment of type SET and cardinality 0..*.
SET<INT>	getBatchTotalNumber() Gets attribute batchTotalNumber of type SET and cardinality 0..*.
SC	getName() Gets attribute name of type SC and cardinality 0..1.
II	getReferenceControlId() Gets attribute referenceControlId of type II and cardinality 0..1.
AssociationSet<Transmission>	getTransmission() Gets association 'transmission' to RIM classes Transmission with cardinality (0..*).
INT	getTransmissionQuantity() Gets attribute transmissionQuantity of type INT and cardinality 0..1.
void	setBatchComment(SET<ST> value) Sets attribute batchComment of type SET and cardinality 0..*.
void	setBatchTotalNumber(SET<INT> value) Sets attribute batchTotalNumber of type SET and cardinality 0..*.
void	setName(SC value) Sets attribute name of type SC and cardinality 0..1.
void	setReferenceControlId(II value) Sets attribute referenceControlId of type II and cardinality 0..1.
void	setTransmission(AssociationSet<Transmission> value) Sets associations 'transmission' to RIM classes Transmission with cardinality (0..*).
void	setTransmissionQuantity(INT value) Sets attribute transmissionQuantity of type INT and cardinality 0..1.

Method Detail

addTransmission

public void addTransmission(Transmission value)

Adds an association 'transmission' to RIM class Transmission.

Parameters: value the added association value

getBatchComment

public SET<ST> getBatchComment()

Gets attribute batchComment of type SET and cardinality 0..*.

This attribute is available to capture comments related to the batch.

Returns: the attribute value

getBatchTotalNumber

public SET<INT> getBatchTotalNumber()

Gets attribute batchTotalNumber of type SET and cardinality 0..*.

The batch total. It is possible that more than a single batch total exists.

Returns: the attribute value

getName

public SC getName()

Gets attribute name of type SC and cardinality 0..1.

This attribute is used by the application processing the batch.

Returns: the attribute value

getReferenceControlId

public II getReferenceControlId()

Gets attribute referenceControlId of type II and cardinality 0..1.

This attribute indicates the control identifier of the batch when it was originally transmitted.

Returns: the attribute value

getTransmission

public AssociationSet<Transmission> getTransmission()

Gets association 'transmission' to RIM classes Transmission with cardinality (0..*).

Returns: the references to the linked classes

getTransmissionQuantity

public INT getTransmissionQuantity()

Gets attribute transmissionQuantity of type INT and cardinality 0..1.

This attribute contains the count of individual transmissions contained within the batch.

Returns: the attribute value

setBatchComment

public void setBatchComment(SET<ST> value)

Sets attribute batchComment of type SET and cardinality 0..*.

This attribute is available to capture comments related to the batch.

Parameters: value the new attribute value

setBatchTotalNumber

public void setBatchTotalNumber(SET<INT> value)

Sets attribute batchTotalNumber of type SET and cardinality 0..*.

The batch total. It is possible that more than a single batch total exists.

Parameters: value the new attribute value

setName

public void setName(SC value)

Sets attribute name of type SC and cardinality 0..1.

This attribute is used by the application processing the batch.

Parameters: value the new attribute value

setReferenceControlId

public void setReferenceControlId(II value)

Sets attribute referenceControlId of type II and cardinality 0..1.

This attribute indicates the control identifier of the batch when it was originally transmitted.

Parameters: value the new attribute value

setTransmission

public void setTransmission(AssociationSet<Transmission> value)

Sets associations 'transmission' to RIM classes Transmission with cardinality (0..*).

Parameters: value the new association values

setTransmissionQuantity

public void setTransmissionQuantity(INT value)

Sets attribute transmissionQuantity of type INT and cardinality 0..1.

This attribute contains the count of individual transmissions contained within the batch.

Parameters: value the new attribute value