Eclipse BIRT Report Object Model (ROM)

SortHint Structure

# Structure Overview

Supports row ordering.

### Details

Display Name: | Sort Hint
Since: | 2.5

### Property Summary

columnName
  Name of the result set column for which hints are defined.
direction
  The sort direction of this result set column.
isOptional
  Indicates whether this sort key can be excluded at runtime.
nullValueOrdering
  The ordering of null vs. non-null values in the sort order.
position
  The 1-based index position of a result set column.

### Description

Supports row ordering. Its properties can be mapped to ODA corresponding values.

# Property Detail

## columnName Property

Name of the result set column for which hints are defined.

### Details

Type: | string
Since: | 2.5
Required: | No
Display Name: | Column Name
JavaScript Type: |
Default Value: | None
Runtime Settable: | Yes

### Description

Name of the result set column for which hints are defined. If a column can only be identified by position, the name may be empty.

## direction Property

The sort direction of this result set column.

### Details

Type: | choice (sortDirection)
Since: | 2.5
Required: | No
Display Name: | Sort Direction
JavaScript Type: |
Default Value: | asc
Runtime Settable: | Yes

### Choices

Name | Display Name | Value | Description
asc | Ascending | asc | the direction of sort hint is ascending.
desc | Descending | desc | the direction of sort hint is descending.

### Description

The sort direction of this result set column.

## isOptional Property

Indicates whether this sort key can be excluded at runtime.

### Details

Type: | boolean
Since: | 2.5
Required: | No
Display Name: | Optional
JavaScript Type: |
Default Value: | false
Runtime Settable: | Yes

### Description

Indicates whether this sort key can be excluded at runtime.

## nullValueOrdering Property

The ordering of null vs. non-null values in the sort order.

### Details

Type: | choice (nullValueOrderingType)
Since: | 2.5
Required: | No
Display Name: | Null Value Ordering
JavaScript Type: |
Default Value: | unknown
Runtime Settable: | Yes

### Choices

Name | Display Name | Value | Description
unknown | Unknown | unknown | the ordering of null in the sort order is unknown.
nullIsFirst | NullIsFirst | nullIsFirst | the ordering of null in the sort order is first.
nullIsLast | NullIsLast | nullIsLast | the ordering of null in the sort order is last.

### Description

The ordering of null vs. non-null values in the sort order.

## position Property

The 1-based index position of a result set column.

### Details

Type: | integer
Since: | 2.5
Required: | No
Display Name: | Column Position
JavaScript Type: |
Default Value: | None
Runtime Settable: | Yes

### Description

The 1-based index position of a result set column.