org.hl7.rim

Interface SortControl

public interface SortControl extends RimObject, InfrastructureRoot

Interface for RIM class SortControl.

Holds specification of sort order for instance matches to a query.

Method Summary
CSgetDirectionCode()
Gets attribute directionCode of type CS and cardinality 0..1.
SCgetElementName()
Gets attribute elementName of type SC and cardinality 0..1.
QuerySpecgetQuerySpec()
Gets association 'querySpec' to RIM class QuerySpec with cardinality (1..1).
INTgetSequenceNumber()
Gets attribute sequenceNumber of type INT and cardinality 0..1.
voidsetDirectionCode(CS value)
Sets attribute directionCode of type CS and cardinality 0..1.
voidsetElementName(SC value)
Sets attribute elementName of type SC and cardinality 0..1.
voidsetQuerySpec(QuerySpec value)
Sets association 'querySpec' to RIM class QuerySpec with cardinality (1..1).
voidsetSequenceNumber(INT value)
Sets attribute sequenceNumber of type INT and cardinality 0..1.

Method Detail

getDirectionCode

public CS getDirectionCode()
Gets attribute directionCode of type CS and cardinality 0..1.

Specifies direction (ascending or descending) of the sort.

Returns: the attribute value

getElementName

public SC getElementName()
Gets attribute elementName of type SC and cardinality 0..1.

Identifies a RIM element in a query response upon which to sort.

Returns: the attribute value

getQuerySpec

public QuerySpec getQuerySpec()
Gets association 'querySpec' to RIM class QuerySpec with cardinality (1..1).

Returns: the reference to the linked class

getSequenceNumber

public INT getSequenceNumber()
Gets attribute sequenceNumber of type INT and cardinality 0..1.

Provides the sequence or primacy of the various SortControls for a given query.

Returns: the attribute value

setDirectionCode

public void setDirectionCode(CS value)
Sets attribute directionCode of type CS and cardinality 0..1.

Specifies direction (ascending or descending) of the sort.

Parameters: value the new attribute value

setElementName

public void setElementName(SC value)
Sets attribute elementName of type SC and cardinality 0..1.

Identifies a RIM element in a query response upon which to sort.

Parameters: value the new attribute value

setQuerySpec

public void setQuerySpec(QuerySpec value)
Sets association 'querySpec' to RIM class QuerySpec with cardinality (1..1).

Parameters: value the new association value

setSequenceNumber

public void setSequenceNumber(INT value)
Sets attribute sequenceNumber of type INT and cardinality 0..1.

Provides the sequence or primacy of the various SortControls for a given query.

Parameters: value the new attribute value