org.hl7.rim

Interface QuerySpec

public interface QuerySpec extends RimObject, QueryEvent

Interface for RIM class QuerySpec.

This class contains the specification of all HL7 Version 3 queries. Attributes common to all queries appear in this class specification.

Method Summary
void	addSortControl(SortControl value) Adds an association 'sortControl' to RIM class SortControl.
TS	getExecutionAndDeliveryTime() Gets attribute executionAndDeliveryTime of type TS and cardinality 0..1.
INT	getInitialQuantity() Gets attribute initialQuantity of type INT and cardinality 0..1.
CE	getInitialQuantityCode() Gets attribute initialQuantityCode of type CE and cardinality 0..1.
CS	getModifyCode() Gets attribute modifyCode of type CS and cardinality 0..1.
SET<II>	getResponseElementGroupId() Gets attribute responseElementGroupId of type SET and cardinality 0..*.
CS	getResponseModalityCode() Gets attribute responseModalityCode of type CS and cardinality 0..1.
CS	getResponsePriorityCode() Gets attribute responsePriorityCode of type CS and cardinality 0..1.
AssociationSet<SortControl>	getSortControl() Gets association 'sortControl' to RIM classes SortControl with cardinality (0..*).
void	setExecutionAndDeliveryTime(TS value) Sets attribute executionAndDeliveryTime of type TS and cardinality 0..1.
void	setInitialQuantity(INT value) Sets attribute initialQuantity of type INT and cardinality 0..1.
void	setInitialQuantityCode(CE value) Sets attribute initialQuantityCode of type CE and cardinality 0..1.
void	setModifyCode(CS value) Sets attribute modifyCode of type CS and cardinality 0..1.
void	setResponseElementGroupId(SET<II> value) Sets attribute responseElementGroupId of type SET and cardinality 0..*.
void	setResponseModalityCode(CS value) Sets attribute responseModalityCode of type CS and cardinality 0..1.
void	setResponsePriorityCode(CS value) Sets attribute responsePriorityCode of type CS and cardinality 0..1.
void	setSortControl(AssociationSet<SortControl> value) Sets associations 'sortControl' to RIM classes SortControl with cardinality (0..*).

Method Detail

addSortControl

public void addSortControl(SortControl value)

Adds an association 'sortControl' to RIM class SortControl.

Parameters: value the added association value

getExecutionAndDeliveryTime

public TS getExecutionAndDeliveryTime()

Gets attribute executionAndDeliveryTime of type TS and cardinality 0..1.

Specifies the time the response is to be returned.

Returns: the attribute value

getInitialQuantity

public INT getInitialQuantity()

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

Defines the maximum size of the response that can be accepted by the requesting application.

Returns: the attribute value

getInitialQuantityCode

public CE getInitialQuantityCode()

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

Defines the units associated with the magnitude of the maximum size limit of a query response that can be accepted by the requesting application

Returns: the attribute value

getModifyCode

public CS getModifyCode()

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

Indicates whether the subscription to a query is new or is being modified.

Returns: the attribute value

getResponseElementGroupId

public SET<II> getResponseElementGroupId()

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

The responseElementGroupId identifies the specific message type to be returned in the query response. This message type must be chosen from the set of message types supported by the receiver responsibilities associated with the query interaction.

Returns: the attribute value