org.hl7.rim

Interface Acknowledgement

public interface Acknowledgement extends RimObject, InfrastructureRoot

Interface for RIM class Acknowledgement.

The Acknowledgement class contains information sent when acknowledging another message.

Method Summary
void	addAcknowledgementDetail(AcknowledgementDetail value) Adds an association 'acknowledgementDetail' to RIM class AcknowledgementDetail.
AssociationSet<AcknowledgementDetail>	getAcknowledgementDetail() Gets association 'acknowledgementDetail' to RIM classes AcknowledgementDetail with cardinality (0..*).
Message	getAcknowledges() Gets association 'acknowledges' to RIM class Message with cardinality (1..1).
Message	getConveyingMessage() Gets association 'conveyingMessage' to RIM class Message with cardinality (1..1).
INT	getExpectedSequenceNumber() Gets attribute expectedSequenceNumber of type INT and cardinality 0..1.
INT	getMessageWaitingNumber() Gets attribute messageWaitingNumber of type INT and cardinality 0..1.
CE	getMessageWaitingPriorityCode() Gets attribute messageWaitingPriorityCode of type CE and cardinality 0..1.
CS	getTypeCode() Gets attribute typeCode of type CS and cardinality 0..1.
void	setAcknowledgementDetail(AssociationSet<AcknowledgementDetail> value) Sets associations 'acknowledgementDetail' to RIM classes AcknowledgementDetail with cardinality (0..*).
void	setAcknowledges(Message value) Sets association 'acknowledges' to RIM class Message with cardinality (1..1).
void	setConveyingMessage(Message value) Sets association 'conveyingMessage' to RIM class Message with cardinality (1..1).
void	setExpectedSequenceNumber(INT value) Sets attribute expectedSequenceNumber of type INT and cardinality 0..1.
void	setMessageWaitingNumber(INT value) Sets attribute messageWaitingNumber of type INT and cardinality 0..1.
void	setMessageWaitingPriorityCode(CE value) Sets attribute messageWaitingPriorityCode of type CE and cardinality 0..1.
void	setTypeCode(CS value) Sets attribute typeCode of type CS and cardinality 0..1.

Method Detail

addAcknowledgementDetail

public void addAcknowledgementDetail(AcknowledgementDetail value)

Adds an association 'acknowledgementDetail' to RIM class AcknowledgementDetail.

Identifies the relationship between an acknowledgment and the error, warning and informational detail accompanying that acknowledgment.

Parameters: value the added association value

getAcknowledgementDetail

public AssociationSet<AcknowledgementDetail> getAcknowledgementDetail()

Gets association 'acknowledgementDetail' to RIM classes AcknowledgementDetail with cardinality (0..*).

Identifies the relationship between an acknowledgment and the error, warning and informational detail accompanying that acknowledgment.

Returns: the references to the linked classes

getAcknowledges

public Message getAcknowledges()

Gets association 'acknowledges' to RIM class Message with cardinality (1..1).

Identifies the relationship between a message and the acknowledgements that acknowledge that message.

Returns: the reference to the linked class

getConveyingMessage

public Message getConveyingMessage()

Gets association 'conveyingMessage' to RIM class Message with cardinality (1..1).

Identifies the relationship between an acknowledgment and the message conveying that acknowledgement.

Returns: the reference to the linked class

getExpectedSequenceNumber

public INT getExpectedSequenceNumber()

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

This attribute is used in the sequence number protocol.

Returns: the attribute value

getMessageWaitingNumber

public INT getMessageWaitingNumber()

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

Indicates the number of messages the acknowledging application has waiting on a queue for the receiving application.

Discussion: These messages would then need to be retrieved via a query. This facilitates receiving applications that cannot receive unsolicited message (i.e. polling).

Examples: If there are 3 low priority messages, 1 medium priority message and 1 high priority message, the message waiting number would be 5, because that is the total number of messages.

Returns: the attribute value

getMessageWaitingPriorityCode

public CE getMessageWaitingPriorityCode()

Gets attribute messageWaitingPriorityCode of type CE and cardinality 0..1.

Indicates the highest importance level of the set of messages the acknowledging application has waiting on a queue for the receiving application.

Discussion: These messages would need to be retrieved via a query. This facilitates receiving applications that cannot receive unsolicited messages (i.e. polling). The specific code specified identifies how important the most important waiting message is (and may govern how soon the receiving application is required to poll for the message).

Priority may be used by local agreement to determine the timeframe in which the receiving application is expected to retrieve the messages from the queue.

Returns: the attribute value

getTypeCode

public CS getTypeCode()

Gets attribute typeCode of type CS and cardinality 0..1.

This attribute contains an acknowledgement code as described in the HL7 message processing rules.

Returns: the attribute value

setAcknowledgementDetail

public void setAcknowledgementDetail(AssociationSet<AcknowledgementDetail> value)

Sets associations 'acknowledgementDetail' to RIM classes AcknowledgementDetail with cardinality (0..*).

Identifies the relationship between an acknowledgment and the error, warning and informational detail accompanying that acknowledgment.

Parameters: value the new association values

setAcknowledges

public void setAcknowledges(Message value)

Sets association 'acknowledges' to RIM class Message with cardinality (1..1).

Identifies the relationship between a message and the acknowledgements that acknowledge that message.

Parameters: value the new association value

setConveyingMessage

public void setConveyingMessage(Message value)

Sets association 'conveyingMessage' to RIM class Message with cardinality (1..1).

Identifies the relationship between an acknowledgment and the message conveying that acknowledgement.

Parameters: value the new association value

setExpectedSequenceNumber

public void setExpectedSequenceNumber(INT value)

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

This attribute is used in the sequence number protocol.

Parameters: value the new attribute value

setMessageWaitingNumber

public void setMessageWaitingNumber(INT value)

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

Indicates the number of messages the acknowledging application has waiting on a queue for the receiving application.

Discussion: These messages would then need to be retrieved via a query. This facilitates receiving applications that cannot receive unsolicited message (i.e. polling).

Examples: If there are 3 low priority messages, 1 medium priority message and 1 high priority message, the message waiting number would be 5, because that is the total number of messages.

Parameters: value the new attribute value

setMessageWaitingPriorityCode

public void setMessageWaitingPriorityCode(CE value)

Sets attribute messageWaitingPriorityCode of type CE and cardinality 0..1.

Indicates the highest importance level of the set of messages the acknowledging application has waiting on a queue for the receiving application.

Priority may be used by local agreement to determine the timeframe in which the receiving application is expected to retrieve the messages from the queue.

Parameters: value the new attribute value

setTypeCode

public void setTypeCode(CS value)

Sets attribute typeCode of type CS and cardinality 0..1.

This attribute contains an acknowledgement code as described in the HL7 message processing rules.

Parameters: value the new attribute value